Back to Devexpress

XtraMdiTabPage.ShowPinButton Property

windowsforms-devexpress-dot-xtratabbedmdi-dot-xtramditabpage-62206683.md

latest3.0 KB
Original Source

XtraMdiTabPage.ShowPinButton Property

Gets or sets whether the current XtraMdiTabPage should display its pin button.

Namespace : DevExpress.XtraTabbedMdi

Assembly : DevExpress.XtraBars.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

csharp
[DefaultValue(DefaultBoolean.Default)]
public virtual DefaultBoolean ShowPinButton { get; set; }
vb
<DefaultValue(DefaultBoolean.Default)>
Public Overridable Property ShowPinButton As DefaultBoolean

Property Value

TypeDefaultDescription
DefaultBooleanDefault

true if the current XtraMdiTabPage should display its pin button; otherwise, false.

|

Available values:

NameDescriptionReturn Value
True

The value is true.

|

0

| | False |

The value is false.

|

1

| | Default |

The value is specified by a global option or a higher-level object.

|

2

|

Remarks

If a XtraMdiTabPage‘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 XtraMdiTabPages are automatically placed before unpinned tabs. Use the XtraMdiTabPage.Pinned property to pin/unpin XtraMdiTabPages in code.

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

See Also

AllowPin

Pinned

PinPageButtonShowMode

XtraMdiTabPage Class

XtraMdiTabPage Members

DevExpress.XtraTabbedMdi Namespace