IDocumentDefaultProperties.AllowPin Property

Gets or sets whether the current Document can be pinned.

Namespace: DevExpress.XtraBars.Docking2010.Views.Tabbed

Assembly: DevExpress.XtraBars.v21.2.dll

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

Declaration

C#

DefaultBoolean AllowPin { get; set; }

VB.NET

Property AllowPin As DefaultBoolean

Property Value

Type	Description
DefaultBoolean	A DefaultBoolean enumerator value specifying whether the current Document can be pinned. The DefaultBoolean.Default value acts identically to the DefaultBoolean.False value.

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

Tabs, which represent Documents within a TabbedView, can be pinned at runtime. Pinned tabs are placed before unpinned ones. A pin-able tab displays the Pin Button next to its Close Button (see the figure below).

The AllowPin property, accessible via the Document.Properties object, specifies whether the current Document can be pinned. To enable or disable this feature for all Documents within a Tabbed View, use the IDocumentProperties.AllowPin property instead (the AllowPin property overrides this global pin setting for individual Documents).

Use the Document.Pinned property in code to pin/unpin individual tabs.