Version: 5.6 (switch to 2017.1b)
LanguageEnglish
  • C#
  • JS

Script language

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

EditorGUILayout.ToggleLeft

Other Versions
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

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> 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(label: string, value: bool, params options: GUILayoutOption[]): bool;
public static bool ToggleLeft(string label, bool value, params GUILayoutOption[] options);
public static function ToggleLeft(label: GUIContent, value: bool, params options: GUILayoutOption[]): bool;
public static bool ToggleLeft(GUIContent label, bool value, params GUILayoutOption[] options);
public static function ToggleLeft(label: string, value: bool, labelStyle: GUIStyle, params options: GUILayoutOption[]): bool;
public static bool ToggleLeft(string label, bool value, GUIStyle labelStyle, params GUILayoutOption[] options);
public static function ToggleLeft(label: GUIContent, value: bool, labelStyle: GUIStyle, params options: GUILayoutOption[]): bool;
public static bool ToggleLeft(GUIContent label, bool value, GUIStyle labelStyle, params GUILayoutOption[] options);

Parameters

label Label to display next to the toggle.
value The value to edit.
labelStyle Optional GUIStyle to use for the label.
options An 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.

Leave Feedback

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright © 2017 Unity Technologies. Publication: 5.6-001M. Built: 2017-06-19.
Tutorials Community Answers Knowledge Base Forums Asset Store