windowsforms-devexpress-dot-xtrabars-dot-docking-dot-dockpanel-053df949.md
Fires on a regular (push) custom header button click.
Namespace : DevExpress.XtraBars.Docking
Assembly : DevExpress.XtraBars.v25.2.dll
NuGet Package : DevExpress.Win.Navigation
public event ButtonEventHandler CustomButtonClick
Public Event CustomButtonClick As ButtonEventHandler
The CustomButtonClick event's data class is ButtonEventArgs. The following properties provide information specific to this event:
| Property | Description |
|---|---|
| Button | Gets a custom header button or a custom Win8 button associated with the current event. |
The CustomButtonClick event is fired for custom header buttons of regular (push) type only. Check buttons and group radio buttons do not raise this event. Buttons type is specified via the Properties.Style and Properties.GroupIndex properties.
The CustomButtonClick is a common event for the entire DockPanel. To identify exactly which custom button was clicked, use the ButtonEventArgs.Button or Properties.Tag properties.
See the Header Buttons topic to learn more.
The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CustomButtonClick event.
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.
winforms-docking-display-custom-header-buttons/CS/CustomHeaderButtonsExample/Form1.cs#L20
panelContainer1.CustomButtonChecked += new DevExpress.XtraBars.Docking2010.ButtonEventHandler(panelContainer1_CustomButtonChecked);
panelContainer1.CustomButtonClick += new DevExpress.XtraBars.Docking2010.ButtonEventHandler(panelContainer1_CustomButtonClick);
}
winforms-docking-display-custom-header-buttons/VB/Form1.vb#L22
AddHandler panelContainer1.CustomButtonChecked, AddressOf panelContainer1_CustomButtonChecked
AddHandler panelContainer1.CustomButtonClick, AddressOf panelContainer1_CustomButtonClick
End Sub
See Also