XtraTabControl.CloseButtonClick Event

Occurs when the Close button displayed within the XtraTabControl’s header is clicked.

Namespace: DevExpress.XtraTab

Assembly: DevExpress.XtraEditors.v24.2.dll

Declaration

C#

[DXCategory("Behavior")]
public event EventHandler CloseButtonClick

VB.NET

<DXCategory("Behavior")>
Public Event CloseButtonClick As EventHandler

Event Data

The CloseButtonClick event's data class is EventArgs.

Remarks

The Close button’s visibility is controlled by the XtraTabControl.HeaderButtons, XtraTabControl.HeaderButtonsShowMode and XtraTabControl.ClosePageButtonShowMode properties.

By default, clicking this button has no effect. You can handle the CloseButtonClick event to implement an appropriate behavior (for instance, hide the currently active tab page).

The event’s e parameter represents an instance of the ClosePageButtonEventArgs class. It provides information on the page whose Close button has been clicked.

Example

The following example shows how to hide tab pages in the XtraTabControl when their Close buttons are clicked. To respond to clicking Close buttons, the XtraTabControl.CloseButtonClick event is handled.

C#

using DevExpress.XtraTab;
using DevExpress.XtraTab.ViewInfo;

private void xtraTabControl1_CloseButtonClick(object sender, EventArgs e) {
    ClosePageButtonEventArgs arg = e as ClosePageButtonEventArgs;
    (arg.Page as XtraTabPage).PageVisible = false;
}

VB.NET

Imports DevExpress.XtraTab
Imports DevExpress.XtraTab.ViewInfo

Private Sub XtraTabControl1_CloseButtonClick(ByVal sender As System.Object, _
ByVal e As System.EventArgs) Handles XtraTabControl1.CloseButtonClick
    Dim arg As ClosePageButtonEventArgs = TryCast(e, ClosePageButtonEventArgs)
    TryCast(arg.Page, XtraTabPage).PageVisible = False
End Sub