Skip to main content
A newer version of this page is available. .

IDocumentDefaultProperties.AllowCollapse Property

Gets or sets whether the current Document can be collapsed.

Namespace: DevExpress.XtraBars.Docking2010.Views.Widget

Assembly: DevExpress.XtraBars.v21.2.dll

NuGet Packages: DevExpress.Win.Design, DevExpress.Win.Navigation

Declaration

DefaultBoolean AllowCollapse { get; set; }

Property Value

Type Description
DefaultBoolean

true if the current Document can be collapsed; otherwise, false.

Available values:

Name Description
True

true. DefaultBoolean.True has a constant value of 0, while the standard true value corresponds to a value of 1. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.

False

false. DefaultBoolean.False has a constant value of 1, while the standard false value corresponds to a value of 0. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.

Default

The default behavior determined by the control’s logic.

Remarks

Collapsed Documents display only their headers. To collapse a Document at runtime, click the corresponding button at the Document’s top right corner. This button’s visibility also depends on the AllowCollapse property value.

The AllowCollapse property overrides a common for all Documents within this WidgetView setting, set via the IDocumentProperties.AllowCollapse property.

See Also