IDocumentDefaultProperties.ShowPinButton Property

Gets or sets whether the Pin Button should be displayed in the current Document‘s tab header.

Namespace: DevExpress.XtraBars.Docking2010.Views.Tabbed

Assembly: DevExpress.XtraBars.v21.2.dll

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

Declaration

C#

DefaultBoolean ShowPinButton { get; set; }

VB.NET

Property ShowPinButton As DefaultBoolean

Property Value

Type	Description
DefaultBoolean	A DefaultBoolean enumerator value that specifies whether the Pin Button should be displayed in the current Document‘s tab header.

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

You can show or hide Pin Buttons for individual Documents via the ShowPinButton property. This property overrides the IDocumentProperties.ShowPinButton property that specifies Pin Buttons visibility for all Documents within a View.

Moreover, you can set whether Pin Buttons are displayed in active, active and focused or all tab headers via the IDocumentGroupProperties.PinPageButtonShowMode property.

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