DropDownButton.DropDownControl Property

Gets or sets the popup control for the button.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[DefaultValue(null)]
[DXCategory("Behavior")]
public virtual IDXDropDownControl DropDownControl { get; set; }

VB.NET

<DXCategory("Behavior")>
<DefaultValue(Nothing)>
Public Overridable Property DropDownControl As IDXDropDownControl

Property Value

Type	Default	Description
IDXDropDownControl	null	A popup control object.

Remarks

You can use the following objects for a popup control:

• PopupMenu - a popup menu managed by a BarManager or RibbonControl component.
• PopupControlContainer - a container for other controls. This control is also managed by a BarManager or RibbonControl component.
• DXPopupMenu - a popup menu.

Note

For the PopupMenu and PopupControlContainer objects to work correctly, ensure that they are associated with a BarManager or RibbonControl component. Use their Manager or Ribbon property to bind the objects to one of these components.

Before a popup control is displayed, the DropDownButton.ShowDropDownControl event is raised. Handle this event to dynamically customize the popup control, block it in specific cases, or supply a custom popup control dynamically.

The DropDownButton.ArrowButtonClick event allows you to display a custom popup control when the user clicks the drop-down arrow.

To open the popup control in code, call the DropDownButton.ShowDropDown method. The DropDownButton.HideDropDown method closes the popup control.

The code sample below illustrates how to add a drop-down menu to a drop-down button.

C#

DXPopupMenu popupMenu = new DXPopupMenu();
popupMenu.Items.Add(new DXMenuItem() { Caption = "Menu Item" });
popupMenu.Items.Add(new DXMenuCheckItem() { Caption = "Check Item" });
dropDownButton1.DropDownControl = popupMenu;

VB.NET

Dim popupMenu As New DXPopupMenu()
popupMenu.Items.Add(New DXMenuItem() With {.Caption = "Menu Item"})
popupMenu.Items.Add(New DXMenuCheckItem() With {.Caption = "Check Item"})
dropDownButton1.DropDownControl = popupMenu

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the DropDownControl property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-assign-popupmenu-to-dropdownbutton/CS/DropDownButtonExample/Form1.cs#L23

    //create and assign PopupMenu
    dropDownButton.DropDownControl = CreatePopupMenu(new BarItem[] { item1, item2 }, this.barManager1, "MyPopupMenu");
}

VB.NET

winforms-assign-popupmenu-to-dropdownbutton/VB/DropDownButtonExample/Form1.vb#L24

    'create and assign PopupMenu
    dropDownButton.DropDownControl = CreatePopupMenu(New BarItem() {item1, item2}, barManager1, "MyPopupMenu")
End Sub