Toggle
Make a toggle.
Read time 6 minutesLast updated 6 days ago
Definition
- Type: Method
- Namespace: UnityEditor
- Assembly: UnityEditor
Toggle(bool, GUILayoutOption[])
Make a toggle.
public static bool Toggle(bool value, params GUILayoutOption[] options)
Parameters
The shown state of the toggle.
An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.\
Additional Resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight.
Returns
Type | Description |
|---|---|
| bool | The selected state of the toggle. |
Remarks
Show a button if the toggle control is selected.
Examples
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(); }}
Toggle(string, bool, GUILayoutOption[])
Make a toggle.
public static bool Toggle(string label, bool value, params GUILayoutOption[] options)
Parameters
Optional label in front of the toggle.
The shown state of the toggle.
An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.\
Additional Resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight.
Returns
Type | Description |
|---|---|
| bool | The selected state of the toggle. |
Remarks
Show a button if the toggle control is selected.
Examples
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(); }}
Toggle(GUIContent, bool, GUILayoutOption[])
Make a toggle.
public static bool Toggle(GUIContent label, bool value, params GUILayoutOption[] options)
Parameters
Optional label in front of the toggle.
The shown state of the toggle.
An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.\
Additional Resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight.
Returns
Type | Description |
|---|---|
| bool | The selected state of the toggle. |
Remarks
Show a button if the toggle control is selected.
Examples
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(); }}
Toggle(bool, GUIStyle, GUILayoutOption[])
Make a toggle.
public static bool Toggle(bool value, GUIStyle style, params GUILayoutOption[] options)
Parameters
The shown state of the toggle.
An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.\
Additional Resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight.
Returns
Type | Description |
|---|---|
| bool | The selected state of the toggle. |
Remarks
Show a button if the toggle control is selected.
Examples
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(); }}
Toggle(string, bool, GUIStyle, GUILayoutOption[])
Make a toggle.
public static bool Toggle(string label, bool value, GUIStyle style, params GUILayoutOption[] options)
Parameters
Optional label in front of the toggle.
The shown state of the toggle.
An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.\
Additional Resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight.
Returns
Type | Description |
|---|---|
| bool | The selected state of the toggle. |
Remarks
Show a button if the toggle control is selected.
Examples
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(); }}
Toggle(GUIContent, bool, GUIStyle, GUILayoutOption[])
Make a toggle.
public static bool Toggle(GUIContent label, bool value, GUIStyle style, params GUILayoutOption[] options)
Parameters
Optional label in front of the toggle.
The shown state of the toggle.
An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.\
Additional Resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight.
Returns
Type | Description |
|---|---|
| bool | The selected state of the toggle. |
Remarks
Show a button if the toggle control is selected.
Examples
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(); }}