DropdownButton
Make a button that reacts to mouse down, for displaying your own dropdown content.
Read time 3 minutesLast updated 5 days ago
Definition
- Type: Method
- Namespace: UnityEditor
- Assembly: UnityEditor
DropdownButton(GUIContent, FocusType, GUILayoutOption[])
Make a button that reacts to mouse down, for displaying your own dropdown content.
public static bool DropdownButton(GUIContent content, FocusType focusType, params GUILayoutOption[] options)
Parameters
Text, image and tooltip for this button.
Whether the button should be selectable by keyboard or not.
An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.
Additional Resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight.
Additional Resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight.
Returns
Type | Description |
|---|---|
| bool | true when the user clicks the button. |
Remarks
This control does not do anything but returns true on mouse down when clicked, as opposed to regular buttons that return true on mouse up.
This can be used for buttons that should open a GenericMenu or your own custom EditorWindow in dropdown form.
When used with a GenericMenu, use Dropdown and pass the same rect to the method as was used for the button, which you can obtain using GUILayoutUtility.GetLastRect. Note that this will only return a valid rect when EditorGUILayout.DropdownButton returns false. This happens because the last layout event is not used when the click goes through to open a menu.
When used with a custom EditorWindow, use ShowAsDropdown and pass the same rect to the method as was used for the button, which you can obtain using GUILayoutUtility.GetLastRect.
DropdownButton(GUIContent, FocusType, GUIStyle, GUILayoutOption[])
Make a button that reacts to mouse down, for displaying your own dropdown content.
public static bool DropdownButton(GUIContent content, FocusType focusType, GUIStyle style, params GUILayoutOption[] options)
Parameters
Text, image and tooltip for this button.
Whether the button should be selectable by keyboard or not.
Optional style to use.
An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.
Additional Resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight.
Additional Resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight.
Returns
Type | Description |
|---|---|
| bool | true when the user clicks the button. |
Remarks
This control does not do anything but returns true on mouse down when clicked, as opposed to regular buttons that return true on mouse up.
This can be used for buttons that should open a GenericMenu or your own custom EditorWindow in dropdown form.
When used with a GenericMenu, use Dropdown and pass the same rect to the method as was used for the button, which you can obtain using GUILayoutUtility.GetLastRect. Note that this will only return a valid rect when EditorGUILayout.DropdownButton returns false. This happens because the last layout event is not used when the click goes through to open a menu.
When used with a custom EditorWindow, use ShowAsDropdown and pass the same rect to the method as was used for the button, which you can obtain using GUILayoutUtility.GetLastRect.