Document.Pinned Property

Gets or sets whether the Document is currently pinned.

Namespace: DevExpress.XtraBars.Docking2010.Views.Tabbed

Assembly: DevExpress.XtraBars.v18.2.dll

Declaration

C#

[DefaultValue(false)]
public bool Pinned { get; set; }

VB.NET

<DefaultValue(False)>
Public Property Pinned As Boolean

Property Value

Type	Default	Description
Boolean	**false**	true if Document; 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).

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

The IDocumentProperties.AllowPin property specifies whether any Document within a Tabbed View can be pinned. To override this setting for individual Documents, use the IDocumentDefaultProperties.AllowPin property instead.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Pinned 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#L33

private void barButtonItem3_ItemClick(object sender, DevExpress.XtraBars.ItemClickEventArgs e) {
    if (tabbedView1.ActiveDocument != null) (tabbedView1.ActiveDocument as DevExpress.XtraBars.Docking2010.Views.Tabbed.Document).Pinned = true;
}

VB.NET

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

If tabbedView1.ActiveDocument IsNot Nothing Then
    TryCast(tabbedView1.ActiveDocument, DevExpress.XtraBars.Docking2010.Views.Tabbed.Document).Pinned = True
End If