Legacy Documentation: Version 5.2
LanguageEnglish
  • C#
  • JS

Script language

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

EditorGUI.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

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

Switch to Manual
public static function Toggle(position: Rect, value: bool): bool;
public static bool Toggle(Rect position, bool value);
public static function Toggle(position: Rect, label: string, value: bool): bool;
public static bool Toggle(Rect position, string label, bool value);
public static function Toggle(position: Rect, value: bool, style: GUIStyle): bool;
public static bool Toggle(Rect position, bool value, GUIStyle style);
public static function Toggle(position: Rect, label: string, value: bool, style: GUIStyle): bool;
public static bool Toggle(Rect position, string label, bool value, GUIStyle style);
public static function Toggle(position: Rect, label: GUIContent, value: bool): bool;
public static bool Toggle(Rect position, GUIContent label, bool value);
public static function Toggle(position: Rect, label: GUIContent, value: bool, style: GUIStyle): bool;
public static bool Toggle(Rect position, GUIContent label, bool value, GUIStyle style);

Parameters

position Rectangle on the screen to use for the toggle.
label Optional label in front of the toggle.
value The shown state of the toggle.
style Optional GUIStyle.

Returns

bool The selected state of the toggle.

Description

Make a toggle.


Toggle control in an Editor Window.

	// Use a toggle button to show/hide a button that can close the window.
	
	class EditorGUIToggle extends EditorWindow {
	
		var showClose : boolean = true;
	
		@MenuItem("Examples/EditorGUI Toggle usage")
		static function Init() {
			var window = GetWindow(EditorGUIToggle);
			window.Show();
		}
		
		function OnGUI() {
			showClose = EditorGUI.Toggle(Rect(0,5,position.width,20),
						"Show Close Button",
						showClose);
			if(showClose)
				if(GUI.Button(Rect(0, 25, position.width, 100),"Close Window!"))
					this.Close();
		}
	}
Copyright © 2015 Unity Technologies
Learn Community Asset Store Buy Download LegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information