Legacy Documentation: Version 2018.1 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

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

EditorGUI.Toggle

Other Versions
Leave feedback
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 method Toggle(position: Rect, value: bool): bool;
public static bool Toggle(Rect position, bool value);
public static method Toggle(position: Rect, label: string, value: bool): bool;
public static bool Toggle(Rect position, string label, bool value);
public static method Toggle(position: Rect, value: bool, style: GUIStyle): bool;
public static bool Toggle(Rect position, bool value, GUIStyle style);
public static method Toggle(position: Rect, label: string, value: bool, style: GUIStyle): bool;
public static bool Toggle(Rect position, string label, bool value, GUIStyle style);
public static method Toggle(position: Rect, label: GUIContent, value: bool): bool;
public static bool Toggle(Rect position, GUIContent label, bool value);
public static method Toggle(position: Rect, label: GUIContent, value: bool, style: GUIStyle): bool;
public static bool Toggle(Rect position, GUIContent label, bool value, GUIStyle style);

Parameters

positionRectangle on the screen to use for the toggle.
labelOptional label in front of the toggle.
valueThe shown state of the toggle.
styleOptional GUIStyle.

Returns

bool The selected state of the toggle.

Description

Make a toggle.


Toggle control in an Editor Window.

no example available in JavaScript
// Use a toggle button to show/hide a button that can close the window.
using UnityEngine;
using UnityEditor;

class EditorGUIToggle : EditorWindow
{
    bool showClose =  true;

    [MenuItem("Examples/EditorGUI Toggle usage")]
    void Init()
    {
        EditorGUIToggle window = (EditorGUIToggle)GetWindow(typeof(EditorGUIToggle), true, "My Empty Window");
        window.Show();
    }

    void OnGUI()
    {
        showClose = EditorGUI.Toggle(new Rect(0, 5, position.width, 20),
                "Show Close Button",
                showClose);
        if (showClose)
            if (GUI.Button(new Rect(0, 25, position.width, 100), "Close Window!"))
                this.Close();
    }
}

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

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 © 2018 Unity Technologies. Publication: 2018.1-002N. Built: 2018-12-04.
TutorialsCommunity AnswersKnowledge BaseForumsAsset StoreLegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information