IDocumentGroupDefaultProperties.PinPageButtonShowMode Property

Gets or sets which tab headers within the current DocumentGroup should display their Pin Buttons.

Namespace: DevExpress.XtraBars.Docking2010.Views.Tabbed

Assembly: DevExpress.XtraBars.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

PinPageButtonShowMode PinPageButtonShowMode { get; set; }

VB.NET

Property PinPageButtonShowMode As PinPageButtonShowMode

Property Value

Type	Description
PinPageButtonShowMode	A PinPageButtonShowMode enumerator value that specifies which tab headers within the current DocumentGroup should display their Pin Buttons.

Available values:

Name	Description
Default	A Default value. Acts identically to the PinPageButtonShowMode.InActiveTabPageHeaderAndOnMouseHover value.
InAllTabPageHeaders	All existing tab headers should display a pin button.
InActiveTabPageHeader	Only an active tab page header should display a Pin Button.
InActiveTabPageHeaderAndOnMouseHover	Only active and hovered tab headers should display a pin button.

Remarks

The IDocumentProperties.AllowPin property specifies whether any Document within a TabbedView can be pinned. When this feature is enabled, use the IDocumentProperties.ShowPinButton property to specify Pin Buttons visibility. If Pin Buttons are not hidden, you can specify whether only active, active and focused or all tab headers should display their Pin Buttons via the IDocumentGroupProperties.PinPageButtonShowMode property. This property can be overridden for individual DocumentGroups via the PinPageButtonShowMode property.

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