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.DropdownButton

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 DropdownButton(content: GUIContent, focusType: FocusType, params options: GUILayoutOption[]): bool;
public static bool DropdownButton(GUIContent content, FocusType focusType, params GUILayoutOption[] options);
public static function DropdownButton(content: GUIContent, focusType: FocusType, style: GUIStyle, params options: GUILayoutOption[]): bool;
public static bool DropdownButton(GUIContent content, FocusType focusType, GUIStyle style, params GUILayoutOption[] options);

Parameters

content Text, image and tooltip for this button.
focusType Whether the button should be selectable by keyboard or not.
style Optional style to use.
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.

Returns

bool true when the user clicks the button.

Description

Make a button that reacts to mouse down, for displaying your own dropdown content.

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 GenericMenu.Dropdown and pass the same rect to the method as was used for the button, which you can obtain using GUILayoutUtility.GetLastRect.

When used with a custom EditorWindow, use EditorWindow.ShowAsDropdown and pass the same rect to the method as was used for the button, which you can obtain using GUILayoutUtility.GetLastRect.