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.v24.1.dll
NuGet Package: DevExpress.Win.Navigation
Declaration
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 | Return Value |
|---|---|---|
| True | The value is true. |
|
| False | The value is false. |
|
| Default | The value is specified by a global option or a higher-level object. |
|
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.