XtraTabControl.ClosePageButtonShowMode Property

Gets or sets whether Close buttons are displayed in individual tab pages and the tab control’s header.

Namespace: DevExpress.XtraTab

Assembly: DevExpress.XtraEditors.v21.2.dll

Declaration

[DefaultValue(ClosePageButtonShowMode.Default)]
[DXCategory("Behavior")]
public virtual ClosePageButtonShowMode ClosePageButtonShowMode { get; set; }

Property Value

Type Default Description
ClosePageButtonShowMode

Default

A ClosePageButtonShowMode value that specifies the display mode for Close buttons.

Available values:

Name Description
Default

The default behavior determined by controls.

For a XtraTabControl, the Close button within the tab control’s header is displayed as specified by the control’s HeaderButtonsShowMode property. Close buttons in individual pages are hidden.

For a TabbedView in a DocumentManager, the Default option is equivalent to ClosePageButtonShowMode.InActiveTabPageHeaderAndOnMouseHover.

InTabControlHeader

The Close button is displayed in the tab control’s header, as specified by the control’s HeaderButtonsShowMode property.

InAllTabPageHeaders

Close buttons are displayed in all pages. The Close button in the control’s header is hidden.

InActiveTabPageHeader

A Close button is displayed in the active page. The Close button in the control’s header is hidden.

InAllTabPagesAndTabControlHeader

Close buttons are displayed in all pages and in the control’s header. The visibility of the Close button within the tab control’s header is specified by the control’s HeaderButtonsShowMode property.

InActiveTabPageAndTabControlHeader

Close buttons are displayed in the tab control’s header, and within the active page. The visibility of the Close button within the tab control’s header is specified by the control’s HeaderButtonsShowMode property.

InActiveTabPageHeaderAndOnMouseHover

Close buttons are displayed within an active tab, and within an inactive tab when the mouse is hovered over it. The visibility of the Close buttons within the tab control’s header is specified by the HeaderButtonsShowMode property.

Remarks

Close buttons can be displayed in the tab control’s header and individual tab pages. Use the ClosePageButtonShowMode to specify the visibility of Close buttons. If this property is set to a value that allows the Close button in the tab control’s header to be displayed, this button can still be hidden via the XtraTabControl.HeaderButtonsShowMode property. See the ClosePageButtonShowMode enumeration for a description of available options.

To hide the Close button within a specific page, use the XtraTabPage.ShowCloseButton

Note that by default, clicking Close buttons has no effect. Handle the XtraTabControl.CloseButtonClick event to respond to button clicking.

See Also