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

Script language

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

EditorGUI.HandlePrefixLabel

Other Versions
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 HandlePrefixLabel(totalPosition: Rect, labelPosition: Rect, label: GUIContent, id: int = 0, style: GUIStyle = EditorStyles.label): void;
public static void HandlePrefixLabel(Rect totalPosition, Rect labelPosition, GUIContent label, int id = 0, GUIStyle style = EditorStyles.label);

Parameters

totalPosition Rectangle on the screen to use in total for both the label and the control.
labelPosition Rectangle on the screen to use for the label.
label Label to show for the control.
id The unique ID of the control. If none specified, the ID of the following control is used.
style Optional GUIStyle to use for the label.

Description

Make a label for some control.

HandlePrefixLabel is like PrefixLabel but allows custom control over the label position by supplying its Rect explicitly. PrefixLabel or HandlePrefixLabel should be used when creating a control with a connected label. It ensures that when the label is clicked, the control will get keyboard focus. For this reason it is important that the same ID is supplied to PrefixLabel or HandlePrefixLabel as to the control itself. It is also possible to not supply a Control ID, in which case the one from the immediately following control is automatically used.

Leave Feedback

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 © 2017 Unity Technologies. Publication: 5.6-001M. Built: 2017-06-19.
Tutorials Community Answers Knowledge Base Forums Asset Store