Highlight
Highlights an element in the editor.
Read time 2 minutesLast updated 5 days ago
Definition
- Type: Method
- Namespace: UnityEditor
- Assembly: UnityEditor.CoreModule
Highlight(string, string)
Highlights an element in the editor.
public static bool Highlight(string windowTitle, string text)
Parameters
Returns
Type | Description |
|---|---|
| bool | true if the requested element was found; otherwise |
Remarks
This function will highlight the specified element in the specified window. If the element could not be found, the function returns false. If the element is inside a scrollview and is not currently visible, the scrollview will first automatically scroll to reveal the element and then highlight it.
Once the element is highlighted it will stay highlighted until either the Highlighter.Stop function is called, or the element disappears from view. The element could disappear from view if the user scrolls away from it, the window is closed, the section of the GUI with the element in it is collapsed or otherwise hidden, or when starting or stopping Play Mode.
Most EditorGUI controls can be highlighted using their label as identifier.
Any control that uses the SerializedProperty system can be highlighted using its SerializedProperty.propertyPath.
Any element with text in it can be highlighted using that text as identifier, which is for example useful for buttons.
See the HighlightSearchMode enum for more details on identifying elements.
Additional Resources: Highlighter.Stop, Highlighter.HighlightIdentifier.
Highlight(string, string, HighlightSearchMode)
Highlights an element in the editor.
public static bool Highlight(string windowTitle, string text, HighlightSearchMode mode)
Parameters
The title of the window the element is inside.
The text to identify the element with.
Optional mode to specify how to search for the element.
Returns
Type | Description |
|---|---|
| bool | true if the requested element was found; otherwise |
Remarks
This function will highlight the specified element in the specified window. If the element could not be found, the function returns false. If the element is inside a scrollview and is not currently visible, the scrollview will first automatically scroll to reveal the element and then highlight it.
Once the element is highlighted it will stay highlighted until either the Highlighter.Stop function is called, or the element disappears from view. The element could disappear from view if the user scrolls away from it, the window is closed, the section of the GUI with the element in it is collapsed or otherwise hidden, or when starting or stopping Play Mode.
Most EditorGUI controls can be highlighted using their label as identifier.
Any control that uses the SerializedProperty system can be highlighted using its SerializedProperty.propertyPath.
Any element with text in it can be highlighted using that text as identifier, which is for example useful for buttons.
See the HighlightSearchMode enum for more details on identifying elements.
Additional Resources: Highlighter.Stop, Highlighter.HighlightIdentifier.