Back to Devexpress

XtraTabbedMdiManager.PinPageButtonShowMode Property

windowsforms-devexpress-dot-xtratabbedmdi-dot-xtratabbedmdimanager-389547c8.md

latest3.5 KB
Original Source

XtraTabbedMdiManager.PinPageButtonShowMode Property

Gets or sets which XtraMdiTabPages should display a Pin Button on their tab headers.

Namespace : DevExpress.XtraTabbedMdi

Assembly : DevExpress.XtraBars.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

csharp
[DefaultValue(PinPageButtonShowMode.Default)]
[DXCategory("Behavior")]
public virtual PinPageButtonShowMode PinPageButtonShowMode { get; set; }
vb
<DXCategory("Behavior")>
<DefaultValue(PinPageButtonShowMode.Default)>
Public Overridable Property PinPageButtonShowMode As PinPageButtonShowMode

Property Value

TypeDefaultDescription
PinPageButtonShowModeDefault

A PinPageButtonShowMode enumerator value that specifies which XtraMdiTabPages should display a Pin Button on their tab headers.

|

Available values:

NameDescription
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

If a XtraTabbedMdiManager‘s IDocumentDefaultProperties.AllowPin property is set to true , this tab can be pinned by an end-user at runtime by clicking a Pin Button on the tab header. Pinned XtraTabbedMdiManagers are automatically placed before unpinned tabs. Use the XtraMdiTabPage.Pinned property to pin/unpin XtraTabbedMdiManagers in code.

Pin Button visibility is specified via the XtraMdiTabPage.ShowPinButton property. You can also specify tab headers for which XtraTabbedMdiManagers - activated only, activated and focused or all existing - should display their Pin Buttons. Use the PinPageButtonShowMode property to do so.

See Also

AllowPin

Pinned

ShowPinButton

XtraTabbedMdiManager Class

XtraTabbedMdiManager Members

DevExpress.XtraTabbedMdi Namespace