Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

EditorGUILayout.ToggleLeft

static function ToggleLeft(label: string, value: bool, params options: GUILayoutOption[]): bool;
static bool ToggleLeft(string label, bool value, params GUILayoutOption[] options);
static def ToggleLeft(label as string, value as bool, *options as GUILayoutOption[]) as bool
static function ToggleLeft(label: GUIContent, value: bool, params options: GUILayoutOption[]): bool;
static bool ToggleLeft(GUIContent label, bool value, params GUILayoutOption[] options);
static def ToggleLeft(label as GUIContent, value as bool, *options as GUILayoutOption[]) as bool
static function ToggleLeft(label: string, value: bool, labelStyle: GUIStyle, params options: GUILayoutOption[]): bool;
static bool ToggleLeft(string label, bool value, GUIStyle labelStyle, params GUILayoutOption[] options);
static def ToggleLeft(label as string, value as bool, labelStyle as GUIStyle, *options as GUILayoutOption[]) as bool
static function ToggleLeft(label: GUIContent, value: bool, labelStyle: GUIStyle, params options: GUILayoutOption[]): bool;
static bool ToggleLeft(GUIContent label, bool value, GUIStyle labelStyle, params GUILayoutOption[] options);
static def ToggleLeft(label as GUIContent, value as bool, labelStyle as GUIStyle, *options as GUILayoutOption[]) as bool

Parameters

labelLabel to display next to the toggle.
valueThe value to edit.
labelStyleOptional GUIStyle to use for the label.
optionsAn optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.
See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight.

Description

Make a toggle field where the toggle is to the left and the label immediately to the right of it.

EditorGUILayout.ToggleLeft is similar to GUILayout.Toggle but respects the EditorGUI.showMixedValue property and handles keyboard focus consistent with other Editor controls.