XtraMdiTabPage.ShowPinButton Property

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

Namespace: DevExpress.XtraTabbedMdi

Assembly: DevExpress.XtraBars.v21.2.dll

NuGet Packages: DevExpress.Win.Design, DevExpress.Win.Navigation

Declaration

C#

[DefaultValue(DefaultBoolean.Default)]
public virtual DefaultBoolean ShowPinButton { get; set; }

VB.NET

<DefaultValue(DefaultBoolean.Default)>
Public Overridable Property ShowPinButton As DefaultBoolean

Property Value

Type	Default	Description
DefaultBoolean	Default	true if the current XtraMdiTabPage should display its pin button; otherwise, false.

Available values:

Name	Description
True	true. DefaultBoolean.True has a constant value of 0, while the standard true value corresponds to a value of 1. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.
False	false. DefaultBoolean.False has a constant value of 1, while the standard false value corresponds to a value of 0. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.
Default	The default behavior determined by the control’s logic.

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.