ButtonEventArgs.Button Property

Gets a custom header button or a custom Win8 button associated with the current event.

Namespace: DevExpress.XtraBars.Docking2010

Assembly: DevExpress.XtraBars.v23.2.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

public IButton Button { get; }

VB.NET

Public ReadOnly Property Button As IButton

Property Value

Type	Description
IButton	An IButton object that is a custom header button associated with the current event.

Remarks

Since the DockPanel.CustomButtonChecked, DockPanel.CustomButtonUnchecked and DockPanel.CustomButtonClick events are common events for all custom header buttons within a ButtonEventArgs, the Button is used to identify exactly which custom button raised an event. Another way to get the target button is to use this button’s Properties.Tag property. See the Header Buttons topic to learn more.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Button 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-docking-display-custom-header-buttons/CS/CustomHeaderButtonsExample/Form1.cs#L33

void panelContainer1_CustomButtonChecked(object sender, DevExpress.XtraBars.Docking2010.ButtonEventArgs e) {
    if (e.Button == panelContainer1.CustomHeaderButtons[4]) (panelContainer1.ActiveChild.ControlContainer.Controls[0] as MemoEdit).Properties.Appearance.TextOptions.HAlignment = HorzAlignment.Near;
    if (e.Button == panelContainer1.CustomHeaderButtons[3]) (panelContainer1.ActiveChild.ControlContainer.Controls[0] as MemoEdit).Properties.Appearance.TextOptions.HAlignment = HorzAlignment.Center;

VB.NET

winforms-docking-display-custom-header-buttons/VB/Form1.vb#L35

Private Sub panelContainer1_CustomButtonChecked(ByVal sender As Object, ByVal e As DevExpress.XtraBars.Docking2010.ButtonEventArgs)
    If (e.Button Is panelContainer1.CustomHeaderButtons(4)) Then
        TryCast(panelContainer1.ActiveChild.ControlContainer.Controls(0), MemoEdit).Properties.Appearance.TextOptions.HAlignment = HorzAlignment.Near