TabFormPage.ShowCloseButton Property

Gets or sets whether the current TabFormPage displays the Close button in its header.

Namespace: DevExpress.XtraBars

Assembly: DevExpress.XtraBars.v21.2.dll

NuGet Packages: DevExpress.Win.Design, DevExpress.Win.Navigation

Declaration

C#

[DefaultValue(DefaultBoolean.Default)]
public DefaultBoolean ShowCloseButton { get; set; }

VB.NET

<DefaultValue(DefaultBoolean.Default)>
Public Property ShowCloseButton As DefaultBoolean

Property Value

Type	Default	Description
DefaultBoolean	Default	A DefaultBoolean enumeration value that specifies whether the current TabFormPage displays the Close button in its header.

Available values:

Name	Description
True	true. DefaultBoolean.True has a constant value of 0, while the standard true value corresponds to a value of 1. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.
False	false. DefaultBoolean.False has a constant value of 1, while the standard false value corresponds to a value of 0. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.
Default	The default behavior determined by the control’s logic.

Remarks

The TabFormPage can display the Close button. Clicking on it hides the current TabFormPage from the TabForm. See the figure below.

By default, the visibility of the Close button for all TabFormPage objects of the TabForm is controlled by the TabFormControlBase.ShowTabCloseButtons property. The ShowCloseButton property overrides this setting for the current TabFormPage.

After the Close button is clicked, the TabFormControlBase.PageClosing event fires, allowing you to cancel the action if necessary.