LayoutGroup.CustomButtonClick Event

Fires on a regular (push) custom header button click.

Namespace: DevExpress.XtraLayout

Assembly: DevExpress.XtraLayout.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[DXCategory("Behavior")]
public event BaseButtonEventHandler CustomButtonClick

VB.NET

<DXCategory("Behavior")>
Public Event CustomButtonClick As BaseButtonEventHandler

Event Data

The CustomButtonClick event's data class is DevExpress.XtraBars.Docking2010.BaseButtonEventArgs.

Remarks

The CustomButtonClick event is fired for custom header buttons of the regular (push) type only. Check buttons and group radio buttons do not raise this event. The button type is specified by the IButtonProperties.Style and IButtonProperties.GroupIndex properties.

Example

The code below handles the LayoutGroup.CustomButtonClick event to hide the layout group with a click on a button in its header. To add buttons to the header, use the CustomHeaderButtons collection.

C#

private void layoutControlGroup1_CustomButtonClick(object sender, DevExpress.XtraBars.Docking2010.BaseButtonEventArgs e) {
    LayoutControlGroup layoutGroup = sender as LayoutControlGroup;
    if (e.Button.Properties.Caption == "Hide")
        layoutGroup.HideToCustomization();
}

VB.NET

Private Sub layoutControlGroup1_CustomButtonClick(ByVal sender As Object, ByVal e As DevExpress.XtraBars.Docking2010.BaseButtonEventArgs) _
    Handles layoutControlGroup1.CustomButtonClick
    Dim layoutGroup As LayoutControlGroup = TryCast(sender, LayoutControlGroup)
    If e.Button.Properties.Caption = "Hide" Then
        layoutGroup.HideToCustomization()
    End If
End Sub