windowsforms-devexpress-dot-xtrabars-dot-docking-dot-dockpanel-073bb7d3.md
Fires when a custom header button is unchecked.
Namespace : DevExpress.XtraBars.Docking
Assembly : DevExpress.XtraBars.v25.2.dll
NuGet Package : DevExpress.Win.Navigation
public event ButtonEventHandler CustomButtonUnchecked
Public Event CustomButtonUnchecked As ButtonEventHandler
The CustomButtonUnchecked 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 CustomButtonUnchecked is fired by custom header buttons of check button type only. Regular (push) buttons and group radio buttons do not raise this event. The button type is specified via the IButtonProperties.Style and IButtonProperties.GroupIndex properties.
The CustomButtonUnchecked is a common event for the entire DockPanel. To identify exactly which custom button was checked, use the ButtonEventArgs.Button or IButtonProperties.Tag properties.
See the Header Buttons topic to learn more.
The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CustomButtonUnchecked 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#L18
InitializeComponent();
panelContainer1.CustomButtonUnchecked += new DevExpress.XtraBars.Docking2010.ButtonEventHandler(panelContainer1_CustomButtonUnchecked);
panelContainer1.CustomButtonChecked += new DevExpress.XtraBars.Docking2010.ButtonEventHandler(panelContainer1_CustomButtonChecked);
winforms-docking-display-custom-header-buttons/VB/Form1.vb#L20
InitializeComponent()
AddHandler panelContainer1.CustomButtonUnchecked, AddressOf panelContainer1_CustomButtonUnchecked
AddHandler panelContainer1.CustomButtonChecked, AddressOf panelContainer1_CustomButtonChecked
See Also