Skip to main content

XtraTabbedMdiManager.PinPageButtonShowMode Property

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

Namespace: DevExpress.XtraTabbedMdi

Assembly: DevExpress.XtraBars.v24.2.dll

Declaration

[DefaultValue(PinPageButtonShowMode.Default)]
[DXCategory("Behavior")]
public virtual PinPageButtonShowMode PinPageButtonShowMode { get; set; }

Property Value

Type Default Description
PinPageButtonShowMode Default

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

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

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