ClosePageButtonShowMode Enum

Enumerates values that specify whether Close buttons are displayed in individual tab pages, the tab control’s header, or in both.

Namespace : DevExpress.XtraTab

Assembly : DevExpress.XtraEditors.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

• C#
• VB.NET

public enum ClosePageButtonShowMode

Public Enum ClosePageButtonShowMode

Members

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.

|

Related API Members

The following properties accept/return ClosePageButtonShowMode values:

• IDocumentGroupDefaultProperties.ActualClosePageButtonShowMode
• IDocumentGroupDefaultProperties.ClosePageButtonShowMode
• IDocumentGroupProperties.ClosePageButtonShowMode
• XtraTabbedMdiManager.ClosePageButtonShowMode
• XtraTabControl.ClosePageButtonShowMode

Remarks

The XtraTabControl and XtraTabbedMdiManager components support the tabbed interface. These components provide the XtraTabControl.ClosePageButtonShowMode and XtraTabbedMdiManager.ClosePageButtonShowMode properties, that control the display of Close buttons in individual tab pages and the tab control’s header.

The HeaderButtonsShowMode properties provided by the XtraTabControl and XtraTabbedMdiManager components allow the Close button in the tab control’s header to be hidden. These properties have a higher priority than the ClosePageButtonShowMode properties.

By default, clicking Close buttons in an XtraTabControl has no effect. Handle the XtraTabControl.CloseButtonClick event, to respond to button clicking. When using an XtraTabbedMdiManager component, clicking the Close button hides the corresponding page (form).

See Also

XtraTabControl.ClosePageButtonShowMode

XtraTabControl.HeaderButtonsShowMode

XtraTabbedMdiManager.ClosePageButtonShowMode

XtraTabbedMdiManager.HeaderButtonsShowMode

CloseButtonClick

DevExpress.XtraTab Namespace