Back to Devexpress

IDocumentDefaultProperties.AllowPin Property

windowsforms-devexpress-dot-xtrabars-dot-docking2010-dot-views-dot-tabbed-dot-idocumentdefaultproperties-f18ef16d.md

latest3.3 KB
Original Source

IDocumentDefaultProperties.AllowPin Property

Gets or sets whether the current Document can be pinned.

Namespace : DevExpress.XtraBars.Docking2010.Views.Tabbed

Assembly : DevExpress.XtraBars.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

csharp
DefaultBoolean AllowPin { get; set; }
vb
Property AllowPin As DefaultBoolean

Property Value

TypeDescription
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:

NameDescriptionReturn Value
True

The value is true.

|

0

| | False |

The value is false.

|

1

| | Default |

The value is specified by a global option or a higher-level object.

|

2

|

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.

See Also

AllowPin

Pinned

DocumentPinned

DocumentUnpinned

IDocumentDefaultProperties Interface

IDocumentDefaultProperties Members

DevExpress.XtraBars.Docking2010.Views.Tabbed Namespace