Version: 2017.2 (switch to 2017.3b)
LanguageEnglish
  • C#
  • JS

Script language

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

SerializedProperty.isExpanded

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 var isExpanded: bool;
public bool isExpanded;

Description

Is this property expanded in the inspector?

Serialized properties with child properties (e.g., arrays, custom serializable structs, or custom serializable classes) may be either expanded or folded up in the inspector to reveal or hide their children. The following example displays a note in the inspector when users expand a Quaternion property.

#pragma strict
@CustomPropertyDrawer(Quaternion)
public class QuaternionDrawer extends PropertyDrawer {
	public override function GetPropertyHeight(property: SerializedProperty, label: GUIContent) {
		return EditorGUI.GetPropertyHeight(property);
	}
	public override function OnGUI(position: Rect, property: SerializedProperty, label: GUIContent) {
		// draw the default property editor
		EditorGUI.PropertyField(position, property, label, true);
		// display a warning to discourage users from manually editing child properties on a quaternion
		if (property.isExpanded) {
			position.height = EditorGUIUtility.singleLineHeight;
			position.xMin += EditorGUIUtility.labelWidth;
			EditorGUI.HelpBox(position, "Editing quaternions manually is inadvisable.", MessageType.Warning);
		}
	}
}
using UnityEditor;
using UnityEngine;

[CustomPropertyDrawer(typeof(Quaternion))] public class QuaternionDrawer : PropertyDrawer { public override float GetPropertyHeight(SerializedProperty property, GUIContent label) { // use the default property height, which takes into account the expanded state return EditorGUI.GetPropertyHeight(property); }

public override void OnGUI(Rect position, SerializedProperty property, GUIContent label) { // draw the default property editor EditorGUI.PropertyField(position, property, label, true);

// display a warning to discourage users from manually editing child properties on a quaternion if (property.isExpanded) { position.height = EditorGUIUtility.singleLineHeight; position.xMin += EditorGUIUtility.labelWidth; EditorGUI.HelpBox(position, "Editing quaternions manually is inadvisable.", MessageType.Warning); } } }


Displaying a message when a Quaternion property is expanded.

Note that the value of this flag is shared across all instances of the serialized property in question that have the same property path and target type. For example, folding up a particular property in the inspector for a component will make the same property folded up in the inspector for all other instances of the same component type.

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