AlertControl.Buttons Property

Provides access to the collection of custom buttons that can be displayed in alert windows.

Namespace: DevExpress.XtraBars.Alerter

Assembly: DevExpress.XtraBars.v26.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[DXCategory("Appearance")]
public virtual AlertButtonCollection Buttons { get; }

VB.NET

<DXCategory("Appearance")>
Public Overridable ReadOnly Property Buttons As AlertButtonCollection

Property Value

Type	Description
AlertButtonCollection	An AlertButtonCollection object that contains custom buttons.

Remarks

You can display custom buttons at the bottom of alert windows. To add buttons to the windows, add them to the Buttons collection. When created, an alert window displays all the buttons from the Buttons collection.

Changing the Buttons collection doesn’t affect the existing alert windows. The changes will be applied to newly created alert windows.

A custom button is represented by an AlertButton object. It can function as a regular or check button, dependant on the AlertButton.Style property. By default, an AlertButton object functions as a regular button. Clicking it produces the AlertControl.ButtonClick event.

If the AlertButton.Style property is set to CheckButton, the button functions as a check button, having two states. When a check button is clicked, its check state is toggled and the AlertControl.ButtonDownChanged event fires.

Handle the AlertControl.ButtonClick and AlertControl.ButtonDownChanged events to respond to button clicks. To identify buttons while handling these events, you can use button names, specified by the AlertButton.Name property.

Example

The following example adds two custom buttons to an AlertControl and handles events to process clicks on these buttons.

The first button is a regular button. A click on this button triggers the AlertControl.ButtonClick event.

The second button has checked and unchecked states (AlertButton.Style = AlertButtonStyle.CheckButton). A click on this button triggers the AlertControl.ButtonDownChanged event.

Note

alertControl1 and svgImageCollection1 were added to the form at design time.

The following image shows the resulting alert window:

C#

using DevExpress.XtraEditors;
using DevExpress.XtraBars.Alerter;

namespace DXApplication2 {
    public partial class Form1 : XtraForm {
        public Form1() {
            InitializeComponent();
            CreateCustomButtons();
            // Subscribe to button click events
            alertControl1.ButtonClick += AlertControl1_ButtonClick;
            alertControl1.ButtonDownChanged += AlertControl1_ButtonDownChanged;

            this.Load += Form1_Load;
        }

        private void Form1_Load(object? sender, EventArgs e) {
            // Show an alert window (for demonstration purposes)
            alertControl1.Show(this, "Hello!", "You have 1 unread message.");
        }

        private void CreateCustomButtons() {
            // Create a custom regular button
            AlertButton btn1 = new AlertButton();
            btn1.Hint = "Open file";
            btn1.Name = "buttonOpen";
            btn1.ImageOptions.SvgImage = svgImageCollection1["open"];
            btn1.ImageOptions.SvgImageSize = new Size(16, 16);
            // Create a custom check button
            AlertButton btn2 = new AlertButton();
            btn2.Style = AlertButtonStyle.CheckButton;
            btn2.Down = true;
            btn2.Hint = "Alert On";
            btn2.Name = "buttonAlert";
            btn2.ImageOptions.SvgImage = svgImageCollection1["time"];
            btn2.ImageOptions.SvgImageSize = new Size(16, 16);
            // Add buttons to the AlertControl
            alertControl1.Buttons.Add(btn1);
            alertControl1.Buttons.Add(btn2);
        }

        private void AlertControl1_ButtonDownChanged(object sender, AlertButtonDownChangedEventArgs e) {
            if (e.Button.Name == "buttonAlert")
                MessageBox.Show($"The Alert button is {(e.Button.Down ? "up" : "down")}");
        }

        private void AlertControl1_ButtonClick(object sender, AlertButtonClickEventArgs e) {
            if (e.Button.Name == "buttonOpen")
                MessageBox.Show("The Open button was clicked");
        }
    }
}

VB.NET

Imports DevExpress.XtraEditors
Imports DevExpress.XtraBars.Alerter

Namespace DXApplication2
    Partial Public Class Form1
        Inherits XtraForm

        Public Sub New()
            InitializeComponent()
            CreateCustomButtons()
            ' Subscribe to button click events
            AddHandler alertControl1.ButtonClick, AddressOf AlertControl1_ButtonClick
            AddHandler alertControl1.ButtonDownChanged, AddressOf AlertControl1_ButtonDownChanged

            AddHandler Me.Load, AddressOf Form1_Load
        End Sub

        Private Sub Form1_Load(sender As Object, e As EventArgs)
            ' Show an alert window (for demonstration purposes)
            alertControl1.Show(Me, "Hello!", "You have 1 unread message.")
        End Sub

        Private Sub CreateCustomButtons()
            ' Create a custom regular button
            Dim btn1 As New AlertButton()
            btn1.Hint = "Open file"
            btn1.Name = "buttonOpen"
            btn1.ImageOptions.SvgImage = svgImageCollection1("open")
            btn1.ImageOptions.SvgImageSize = New Size(16, 16)
            ' Create a custom check button
            Dim btn2 As New AlertButton()
            btn2.Style = AlertButtonStyle.CheckButton
            btn2.Down = True
            btn2.Hint = "Alert On"
            btn2.Name = "buttonAlert"
            btn2.ImageOptions.SvgImage = svgImageCollection1("time")
            btn2.ImageOptions.SvgImageSize = New Size(16, 16)
            ' Add buttons to the AlertControl
            alertControl1.Buttons.Add(btn1)
            alertControl1.Buttons.Add(btn2)
        End Sub

        Private Sub AlertControl1_ButtonDownChanged(sender As Object, e As AlertButtonDownChangedEventArgs)
            If e.Button.Name = "buttonAlert" Then
                MessageBox.Show($"The Alert button is {If(e.Button.Down, "up", "down")}")
            End If
        End Sub

        Private Sub AlertControl1_ButtonClick(sender As Object, e As AlertButtonClickEventArgs)
            If e.Button.Name = "buttonOpen" Then
                MessageBox.Show("The Open button was clicked")
            End If
        End Sub
    End Class
End Namespace