Version: 2018.2 (switch to 2018.3b or 2017.4)
LanguageEnglish
  • C#

EditorGUILayout.Toggle

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 bool Toggle(bool value, params GUILayoutOption[] options);
public static bool Toggle(string label, bool value, params GUILayoutOption[] options);
public static bool Toggle(GUIContent label, bool value, params GUILayoutOption[] options);
public static bool Toggle(bool value, GUIStyle style, params GUILayoutOption[] options);
public static bool Toggle(string label, bool value, GUIStyle style, params GUILayoutOption[] options);
public static bool Toggle(GUIContent label, bool value, GUIStyle style, params GUILayoutOption[] options);

Parameters

labelOptional label in front of the toggle.
valueThe shown state of the toggle.
styleOptional GUIStyle.
optionsAn optional list of layout options that specify extra layout 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.

Returns

bool The selected state of the toggle.

Description

Make a toggle.


Show a button if the toggle control is selected.

using UnityEngine;
using UnityEditor;

public class EditorGUILayoutToggle : UnityEditor.EditorWindow { bool showBtn = true;

[MenuItem("Examples/Editor GUILayout Toggle Usage")] static void Init() { EditorGUILayoutToggle window = (EditorGUILayoutToggle)EditorWindow.GetWindow(typeof(EditorGUILayoutToggle), true, "My Empty Window"); window.Show(); }

void OnGUI() { showBtn = EditorGUILayout.Toggle("Show Button", showBtn); if (showBtn) if (GUILayout.Button("Close")) this.Close(); } }

Did you find this page useful? Please give it a rating: