Legacy Documentation: Version 4.6.2
Language: English
  • C#
  • JS
  • Boo

Script language

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

EditorGUI.ToggleLeft

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public static function ToggleLeft(position: Rect, label: string, value: bool, labelStyle: GUIStyle = EditorStyles.label): bool;
public static bool ToggleLeft(Rect position, string label, bool value, GUIStyle labelStyle = EditorStyles.label);
public static def ToggleLeft(position as Rect, label as string, value as bool, labelStyle as GUIStyle = EditorStyles.label) as bool
public static function ToggleLeft(position: Rect, label: GUIContent, value: bool, labelStyle: GUIStyle = EditorStyles.label): bool;
public static bool ToggleLeft(Rect position, GUIContent label, bool value, GUIStyle labelStyle = EditorStyles.label);
public static def ToggleLeft(position as Rect, label as GUIContent, value as bool, labelStyle as GUIStyle = EditorStyles.label) as bool

Parameters

position Rectangle on the screen to use for the toggle.
label Label to display next to the toggle.
value The value to edit.
labelStyle Optional GUIStyle to use for the label.

Returns

bool The value set by the user.

Description

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

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