AlertInfo Class

Contains information to be displayed in an alert window.

Namespace: DevExpress.XtraBars.Alerter

Assembly: DevExpress.XtraEditors.v18.1.dll

Declaration

C#

public class AlertInfo

VB.NET

Public Class AlertInfo

Related API Members

The following members accept/return AlertInfo objects:

• AlertClickEventArgs.Info

Remarks

To show an alert window displaying a specific information, you can create an AlertInfo object with information to be displayed, and pass it to the AlertControl.Show method. An AlertInfo object’s properties allow you to specify the caption, text, and image to be displayed in alert windows. In addition, you can set custom data to the AlertInfo.Tag property. You can subsequently use this data while processing events for alert windows (AlertControl.BeforeFormShow or AlertControl.AlertClick).

Example

The following example shows how to add custom buttons to an AlertControl.

It’s assumed that an AlertControl control has been added to the form at design time. In the example, two custom buttons are added to the control’s AlertControl.Buttons collection. The first button is a regular button, which when clicked, produces the AlertControl.ButtonClick event. The second button has checked and unchecked states. Clicking this button fires the AlertControl.ButtonDownChanged event.

The result is shown below:

C#

using DevExpress.XtraBars.Alerter;

// Create a regular custom button.
AlertButton btn1 = new AlertButton(Image.FromFile(@"c:\folder-16x16.png"));
btn1.Hint = "Open file";
btn1.Name = "buttonOpen";
// Create a check custom button.
AlertButton btn2 = new AlertButton(Image.FromFile(@"c:\clock-16x16.png"));
btn2.Style = AlertButtonStyle.CheckButton;
btn2.Down = true;
btn2.Hint = "Alert On";
btn2.Name = "buttonAlert";
// Add buttons to the AlertControl and subscribe to the events to process button clicks
alertControl1.Buttons.Add(btn1);
alertControl1.Buttons.Add(btn2);
alertControl1.ButtonClick += new AlertButtonClickEventHandler(alertControl1_ButtonClick);
alertControl1.ButtonDownChanged += 
    new AlertButtonDownChangedEventHandler(alertControl1_ButtonDownChanged);

// Show a sample alert window.
AlertInfo info = new AlertInfo("New Window", "Text");
alertControl1.Show(this, info);

void alertControl1_ButtonDownChanged(object sender, 
AlertButtonDownChangedEventArgs e) {
    if (e.ButtonName == "buttonOpen") {
        //...
    }
}

void alertControl1_ButtonClick(object sender, AlertButtonClickEventArgs e) {
    if (e.ButtonName == "buttonAlert") {
        //...
    }
}

VB.NET

Imports DevExpress.XtraBars.Alerter

' Create a regular custom button.
Dim btn1 As AlertButton = New AlertButton(Image.FromFile("c:\folder-16x16.png"))
btn1.Hint = "Open file"
btn1.Name = "buttonOpen"
' Create a check custom button.
Dim btn2 As AlertButton = New AlertButton(Image.FromFile("c:\clock-16x16.png"))
btn2.Style = AlertButtonStyle.CheckButton
btn2.Down = True
btn2.Hint = "Alert On"
btn2.Name = "buttonAlert"
' Add buttons to the AlertControl and subscribe to the events to process button clicks
alertControl1.Buttons.Add(btn1)
alertControl1.Buttons.Add(btn2)
AddHandler alertControl1.ButtonClick, AddressOf alertControl1_ButtonClick
AddHandler alertControl1.ButtonDownChanged, _ 
AddressOf alertControl1_ButtonDownChanged

' Show a sample alert window.
Dim info As AlertInfo = New AlertInfo("New Window", "Text")
alertControl1.Show(Me, info)

Private Sub alertControl1_ButtonDownChanged(ByVal sender As Object, _ 
ByVal e As AlertButtonDownChangedEventArgs)
    If e.ButtonName = "buttonOpen" Then
        '...
    End If
End Sub

Private Sub alertControl1_ButtonClick(ByVal sender As Object, _ 
ByVal e As AlertButtonClickEventArgs)
    If e.ButtonName = "buttonAlert" Then
        '...
    End If
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the AlertInfo class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

alertcontrol-how-to-display-alert-popups-with-different-colors-t190778/CS/WindowsFormsApplication2/CustomAlertControl.cs#L15

protected override AlertForm CreateAlertForm(System.Drawing.Point location, AlertControl control, AlertInfo info) {
    return new MyAlertForm(location, control, info);

how-to-display-the-alertcontrol-according-to-the-task-bar-position-e955/CS/SmartAlertControl/Form1.cs#L18

private void simpleButton1_Click(object sender, EventArgs e) {
    AlertInfo info = new AlertInfo("DX Sample", "This alert takes into account the taskbar position");
    AlertHelper.ShowAlertNearTaskBar(alertControl1, this, info);

XAF_how-to-use-the-alertcontrol-in-xaf-e1041/CS/WinSolution.Module/ShowAlertControlMainWindowController.cs#L38

Form mainForm = (Form)Application.MainWindow.Template;
AlertInfo info = new AlertInfo("Frohe Weihnachten! (Merry Christmas!)", DateTime.Now.ToString(), ImageLoader.Instance.GetImageInfo("Attention").Image);
AlertControl.Show(mainForm, info);

VB.NET

alertcontrol-how-to-display-alert-popups-with-different-colors-t190778/VB/WindowsFormsApplication2/CustomAlertControl.vb#L19

Protected Overrides Function CreateAlertForm(ByVal location As System.Drawing.Point, ByVal control As AlertControl, ByVal info As AlertInfo) As AlertForm
    Return New MyAlertForm(location, control, info)

how-to-display-the-alertcontrol-according-to-the-task-bar-position-e955/VB/SmartAlertControl/Form1.vb#L20

Private Sub simpleButton1_Click(ByVal sender As Object, ByVal e As EventArgs) Handles simpleButton1.Click
    Dim info As New AlertInfo("DX Sample", "This alert takes into account the taskbar position")
    AlertHelper.ShowAlertNearTaskBar(alertControl1, Me, info)

XAF_how-to-use-the-alertcontrol-in-xaf-e1041/VB/WinSolution.Module/ShowAlertControlMainWindowController.vb#L40

Dim mainForm As Form = CType(Application.MainWindow.Template, Form)
Dim info As New AlertInfo("Frohe Weihnachten! (Merry Christmas!)", DateTime.Now.ToString(), ImageLoader.Instance.GetImageInfo("Attention").Image)
AlertControl.Show(mainForm, info)

Inheritance

Object

AlertInfo