DockPanel.DockedAsTabbedDocument Property

Gets or sets whether the DockPanel is displayed as a tab within a Tabbed UI, created using the DocumentManager component.

Namespace: DevExpress.XtraBars.Docking

Assembly: DevExpress.XtraBars.v20.1.dll

Declaration

[DefaultValue(false)]
[XtraSerializableProperty(-1)]
public bool DockedAsTabbedDocument { get; set; }
<DefaultValue(False)>
<XtraSerializableProperty(-1)>
Public Property DockedAsTabbedDocument As Boolean

Property Value

Type Default Description
Boolean

false

true, if the DockPanel is displayed as a tab in a Tabbed UI; otherwise, false.

Remarks

The DockManager can be used together with the DocumentManager component. The DocumentManager allows you to present documents in a number of ways. One of the document presentation styles is a Tabbed UI, which can be enabled by assigning a TabbedView object to the DocumentManager.View property. In this mode, dock panels gain additional features, such as the ability to be docked as tabs. The DockedAsTabbedDocument property allows you to dock a panel as a tab or to identify the panel's current state.

You can prevent the DockPanel from being displayed as a tab in the Tabbed UI by setting the DockPanelOptions.AllowDockAsTabbedDocument property to false. If required, you can forbid the panel to be floating by setting the DockPanelOptions.AllowFloating property to false. The DockPanelOptions object can be accessed via the DockPanel.Options property.

See Also