IDocumentProperties.AllowPin Property

Gets or sets whether any Document within the current TabbedView can be pinned.

Namespace: DevExpress.XtraBars.Docking2010.Views.Tabbed

Assembly: DevExpress.XtraBars.v21.1.dll

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

Declaration

C#

bool AllowPin { get; set; }

VB.NET

Property AllowPin As Boolean

Property Value

Type	Description
Boolean	true if any Document within the current TabbedView can be pinned; otherwise, false.

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 IDocumentDefaultProperties.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 AllowPin property instead, which has a lower priority than the IDocumentDefaultProperties.AllowPin property.

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

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the AllowPin property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-merge-bars-within-the-documentmanager-control-e4950/CS/DocumentManagerBarMerging/Form1.cs#L16

InitializeComponent();
tabbedView1.DocumentProperties.AllowPin = true;
documentManager1.RibbonAndBarsMergeStyle = DevExpress.XtraBars.Docking2010.Views.RibbonAndBarsMergeStyle.Always;

VB.NET

how-to-merge-bars-within-the-documentmanager-control-e4950/VB/DocumentManagerBarMerging/Form1.vb#L17

InitializeComponent()
tabbedView1.DocumentProperties.AllowPin = True
documentManager1.RibbonAndBarsMergeStyle = DevExpress.XtraBars.Docking2010.Views.RibbonAndBarsMergeStyle.Always