Skip to main content

IDocumentGroupDefaultProperties.HeaderButtonsShowMode Property

Gets or sets when tab buttons are displayed within the current DocumentGroup‘s tab header panel.

Namespace: DevExpress.XtraBars.Docking2010.Views.Tabbed

Assembly: DevExpress.XtraBars.v24.2.dll

Declaration

TabButtonShowMode HeaderButtonsShowMode { get; set; }

Property Value

Type Description
TabButtonShowMode

A TabButtonShowMode enumerator value that specifies when tab buttons are displayed within the current DocumentGroup‘s tab header panel. The Default value acts in the same way as the WhenNeeded value.

Available values:

Name Description
Default

The option is equivalent to the TabButtonShowMode.WhenNeeded option.

Always

The Close button is always displayed within the page header panel. The Prev and Next buttons are displayed when the XtraTabControl.MultiLine property is set to false.

Never

Tab buttons are always hidden.

WhenNeeded

Tab buttons are automatically shown when the tab control’s width is insufficient to display all the page headers.

Remarks

The tab header panel can display the Close, Next and Prev buttons. The Next and Prev buttons enable end-users to scroll through the tabbed documents when the DocumentGroup‘s width is insufficient to display all the documents simultaneously. The options provided by the TabButtons enumeration allow you to specify which buttons can be displayed. These options are passed to the IDocumentGroupDefaultProperties.HeaderButtons property.

To specify when the tab buttons must be displayed, use the HeaderButtonsShowMode property. Depending on the HeaderButtonsShowMode property value, tab buttons can be always visible, displayed when required or permanently hidden.

Individual tabbed documents can also display Close buttons, as specified by the IDocumentGroupDefaultProperties.ClosePageButtonShowMode property.

All the properties mentioned are duplicated in the IDocumentGroupProperties interface. Use these to specify common options for all DocumentGroups.

See Also