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

Script language

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

EditorGUILayout.GetControlRect

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 function GetControlRect(params options: GUILayoutOption[]): Rect;
public static Rect GetControlRect(params GUILayoutOption[] options);
public static function GetControlRect(hasLabel: bool, params options: GUILayoutOption[]): Rect;
public static Rect GetControlRect(bool hasLabel, params GUILayoutOption[] options);
public static function GetControlRect(hasLabel: bool, height: float, params options: GUILayoutOption[]): Rect;
public static Rect GetControlRect(bool hasLabel, float height, params GUILayoutOption[] options);
public static function GetControlRect(hasLabel: bool, height: float, style: GUIStyle, params options: GUILayoutOption[]): Rect;
public static Rect GetControlRect(bool hasLabel, float height, GUIStyle style, params GUILayoutOption[] options);

Parameters

hasLabel Optional boolean to specify if the control has a label. Default is true.
height The height in pixels of the control. Default is EditorGUIUtility.singleLineHeight.
style Optional GUIStyle to use for the control.
options An optional list of layout options that specify extra layouting 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.

Description

Get a rect for an Editor control.

When creating a new Editor control it is a sound design to implement the actual control without relying on GUILayout and instead have the control take a Rect as parameter, similar to the controls in the EditorGUI class. This ensures the control can also be used in for example a PropertyDrawer, which does not allow GUILayout.

Once a non-layout version of the control is implemented, a layout version can easily be made as well, which simply calls into the non-layout version. In order to get a rect fitting for the control, the GetControlRect function can be used.