RibbonControl.ApplicationButtonDropDownControl Property

Gets or sets the drop-down control which is invoked when the Application Button is clicked.

Namespace: DevExpress.XtraBars.Ribbon

Assembly: DevExpress.XtraBars.v20.2.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

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

VB.NET

<DefaultValue(Nothing)>
<DXCategory("Behavior")>
Public Overridable Property ApplicationButtonDropDownControl As Object

Property Value

Type	Default	Description
Object	*null*	An object (any control or specific DevExpress component) which is invoked when the Ribbon Form’s Application Button is clicked.

Remarks

The Application Button should provide access to the main menu of an application that uses the Ribbon UI. By default, clicking this button has no effect.

The ApplicationButtonDropDownControl property allows you to specify the control that needs to be displayed when the Application Button is clicked. The property accepts 1) any Control descendant; 2) an object that implements the DevExpress.XtraBars.PopupControl interface.

The following controls implement the DevExpress.XtraBars.PopupControl interface:

• ApplicationMenu - an Application Popup Menu;
• PopupControlContainer - a controls container;
• PopupMenu - a menu;
• GalleryDropDown - a control which encapsulates a gallery.
• BackstageViewControl - allows you to emulate a menu found in Microsoft Office 2010 applications.

To dynamically customize the drop-down control before it’s displayed onscreen, use the RibbonControl.BeforeApplicationButtonContentControlShow or RibbonControl.ApplicationButtonClick event.

If a Control descendant is assigned to the ApplicationButtonDropDownControl property, the Control’s size is changed so that it covers the entire RibbonForm. If a DevExpress.XtraBars.PopupControl object is assigned to the ApplicationButtonDropDownControl property, its size is not affected.

The RibbonControl.HideApplicationButtonContentControl method allows you to close the control assigned to the ApplicationButtonDropDownControl property.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ApplicationButtonDropDownControl 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#

how-to-create-a-ribbon-application-menu-which-looks-similar-to-the-office-2010-one-e2759/CS/Office2010StyleApplicationMenu102/Form1.cs#L11

    InitializeComponent();
    ribbon.ApplicationButtonDropDownControl = new ApplicationButtonDropDownControl();
}

VB.NET

how-to-create-a-ribbon-application-menu-which-looks-similar-to-the-office-2010-one-e2759/VB/Office2010StyleApplicationMenu102/Form1.vb#L10

    InitializeComponent()
    ribbon.ApplicationButtonDropDownControl = New ApplicationButtonDropDownControl()
End Sub