TabbedGroup.CustomHeaderButtonClick Event

Occurs when a custom header button is clicked.

Namespace: DevExpress.XtraLayout

Assembly: DevExpress.XtraLayout.v22.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[DXCategory("Behavior")]
public event CustomHeaderButtonEventHandler CustomHeaderButtonClick

VB.NET

<DXCategory("Behavior")>
Public Event CustomHeaderButtonClick As CustomHeaderButtonEventHandler

Event Data

The CustomHeaderButtonClick event's data class is CustomHeaderButtonEventArgs. The following properties provide information specific to this event:

Property	Description
ActivePage	Gets an active tab page within the tab control.
Button	Gets the currently processed custom header button.

Remarks

Using the TabbedGroup.CustomHeaderButtons collection, you can add custom header buttons to the tabbed group. Handle the CustomHeaderButtonClick event to respond to a header button click. Read the Button argument to determine the button being clicked. See a sample handler below.

C#

private void TabbedGroup_CustomHeaderButtonClick(object sender, DevExpress.XtraTab.ViewInfo.CustomHeaderButtonEventArgs e) {
    // Handle the Left button click.
    if (e.Button == leftButton && tabbedGroup.SelectedTabPageIndex > 0)
        tabbedGroup.SelectedTabPageIndex--;
    // Handle the Right button click.
    if (e.Button == rightButton && tabbedGroup.SelectedTabPageIndex < tabbedGroup.TabPages.Count - 1)
        tabbedGroup.SelectedTabPageIndex++;
    // Handle the Open button click. Executed only when the Photo tab page is active (the group1 tab page).
    if (e.Button == openButton && ((DevExpress.XtraLayout.Tab.LayoutTabPage)e.ActivePage).Group == group1)
        pictureEdit.LoadImage();
}

VB.NET

Protected Sub TabbedGroup_CustomHeaderButtonClickn_Click(ByVal sender As System.Object,
                                   ByVal e As DevExpress.XtraTab.ViewInfo.CustomHeaderButtonEventArgs) Handles tabbedGroup.CustomHeaderButtonClick
    ' Handle the Left button click.  
    If e.Button Is leftButton AndAlso tabbedGroup.SelectedTabPageIndex > 0 Then 
        tabbedGroup.SelectedTabPageIndex -= 1
    End If 
    ' Handle the Right button click.  
    If e.Button Is rightButton AndAlso tabbedGroup.SelectedTabPageIndex < tabbedGroup.TabPages.Count - 1 Then 
        tabbedGroup.SelectedTabPageIndex += 1
    End If 
    ' Handle the Open button click. Executed only when the Photo tab page is active (the group1 tab page).  
    If e.Button Is openButton AndAlso DirectCast(e.ActivePage, DevExpress.XtraLayout.Tab.LayoutTabPage).Group Is group1 Then 
        pictureEdit.LoadImage()
    End If 
End Sub 

See the TabbedGroup.CustomHeaderButtons property for the complete example.