Skip to main content

DockPanel.CustomButtonChecked Event

Fires when a custom header button is checked.

Namespace: DevExpress.XtraBars.Docking

Assembly: DevExpress.XtraBars.v23.1.dll

NuGet Package: DevExpress.Win.Navigation


public event ButtonEventHandler CustomButtonChecked

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.


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.

See Also