Skip to main content

IDocumentGroupProperties.ClosePageButtonShowMode Property

Gets or sets the value that determines the way the Close buttons are displayed in document groups.

Namespace: DevExpress.XtraBars.Docking2010.Views.Tabbed

Assembly: DevExpress.XtraBars.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

ClosePageButtonShowMode ClosePageButtonShowMode { get; set; }

Property Value

Type Description
ClosePageButtonShowMode

A ClosePageButtonShowMode value that determines the way the Close buttons are displayed in document groups.

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

Use a View’s ClosePageButtonShowMode property to specify the way the Close buttons are displayed in document groups. This setting is applied to all document groups by default. The IDocumentGroupDefaultProperties.ClosePageButtonShowMode property allows you to override the ClosePageButtonShowMode property for an individual document group. To override the default setting, set the IDocumentGroupDefaultProperties.ClosePageButtonShowMode property to any ClosePageButtonShowMode value except Default.

If the ClosePageButtonShowMode property is set to Default, the Close buttons are displayed in a selected tab in each document group.

See Also