DockPanel.CustomButtonChecked Event
Fires when a custom header button is checked.
Namespace: DevExpress.XtraBars.Docking
Assembly: DevExpress.XtraBars.v24.1.dll
NuGet Package: DevExpress.Win.Navigation
Declaration
Event Data
The CustomButtonChecked 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. |
Remarks
The CustomButtonChecked event is fired for custom header buttons of two types:
- for check buttons - when a button’s checked state is changed from an unchecked state. The reverse action fires the DockPanel.CustomButtonUnchecked event.
- for group radio buttons - when any button within a group is checked. In the case of group radio buttons, only the CustomButtonChecked event is fired, unchecking the previous button doesn’t raise the DockPanel.CustomButtonUnchecked event.
The CustomButtonChecked is a common event for the entire DockPanel. To identify exactly which custom button was checked, use the ButtonEventArgs.Button property. The button type is specified via the Properties.Style and Properties.GroupIndex properties. To handle a specific button check, use this button’s CheckedChanged event. 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 CustomButtonChecked 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.