AlertControl.Show(Form, String, String) Method

Displays an alert window with the specified text and caption.

Namespace: DevExpress.XtraBars.Alerter

Assembly: DevExpress.XtraBars.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

public void Show(
    Form owner,
    string caption,
    string text
)

VB.NET

Public Sub Show(
    owner As Form,
    caption As String,
    text As String
)

Parameters

Name	Type	Description
owner	Form	An owner of the window. In a multi-monitor system, if the owner is set to null, the window will be displayed on the main monitor. Otherwise, the window will be displayed on the same monitor as the owner.
caption	String	A string that specifies the window’s caption.
text	String	A string that specifies the window’s text, displayed when the text region is not hovered over.

Remarks

If the AlertControl.AllowHtmlText property is enabled, you can use HTML tags to format an alert window’s caption and text. See HTML Text Formatting to learn more.

You can handle the AlertControl.BeforeFormShow event to customize the newly created alert window before its appearance on-screen.

The following example demonstrates how to show and close alert windows:

C#

using DevExpress.XtraBars.Alerter;

// Displays an alert window.
alertControl1.Show(this, "Alert", "The alert description.");

// Closes all active alert windows.
foreach(AlertForm alert in alertControl1.AlertFormList)
    alert.Close();

// Closes the specified alert window.
AlertForm alertWindow = alertControl1.AlertFormList[0];
if(alertWindow != null)
    alertWindow.Close();

VB.NET

Imports DevExpress.XtraBars.Alerter

' Displays an alert window.
alertControl1.Show(Me, "Alert", "The alert description.")

' Closes all active alert windows.
For Each alert As AlertForm In alertControl1.AlertFormList
    alert.Close()
Next alert

' Closes the specified alert window.
Dim alertWindow As AlertForm = alertControl1.AlertFormList(0)
If alertWindow IsNot Nothing Then
    alertWindow.Close()
End If

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Show(Form, String, String) method.

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#

winforms-alert-display-colored-messages-html-css-support/CS/WindowsFormsApplication2/Form1.cs#L22

{
    alertControl2.Show(this, "Caption", "Text");
}