AlertControl.ShowPinButton Property

Gets or sets whether the Pin button must be displayed in newly created alert windows.

Namespace: DevExpress.XtraBars.Alerter

Assembly: DevExpress.XtraBars.v20.1.dll

Declaration

[DefaultValue(true)]
[DXCategory("Appearance")]
public virtual bool ShowPinButton { get; set; }
<DefaultValue(True)>
<DXCategory("Appearance")>
Public Overridable Property ShowPinButton As Boolean

Property Value

Type Default Description
Boolean

true

true if the Pin button must be displayed in newly created alert windows; otherwise, false.

Remarks

An alert window can display the Close, Pin and Dropdown control buttons. The availability of these buttons is specified by the AlertControl.ShowCloseButton, ShowPinButton and AlertControl.PopupMenu properties, respectively. The position of the control buttons is specified by the AlertControl.ControlBoxPosition property.

Clicking the Pin button forces an alert window to stay on-screen until the button is clicked again. If the window is unpinned and the mouse cursor doesn't hover over the window for a specific time, the window is automatically destroyed.

It's also possible to display custom buttons in alert windows. To do this, add items to the AlertControl.Buttons collection.

AlertWindow_Buttons

Changing the ShowPinButton option is not in effect for existing alert windows. The option is applied to newly created windows.

Implements

DevExpress.XtraBars.Alerter.IAlertControl.ShowPinButton
See Also