XtraMessageBox.Show(XtraMessageBoxArgs) Method

Displays an XtraMessageBox with the specified settings.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v24.2.dll

Declaration

C#

public static DialogResult Show(
    XtraMessageBoxArgs args
)

VB.NET

Public Shared Function Show(
    args As XtraMessageBoxArgs
) As DialogResult

Parameters

Name	Type	Description
args	XtraMessageBoxArgs	An XtraMessageBoxArgs object that allows you to dynamically customize the displayed dialog.

Returns

Type	Description
DialogResult	A DialogResult enumerator value that specifies which message box button an end-user has clicked.

Remarks

You can handle the Showing event for the args parameter to dynamically customize the message box content and buttons. The code below illustrates an example.

C#

XtraMessageBoxArgs args = new XtraMessageBoxArgs();
args.Showing += Args_Showing;
args.Caption = "Default Text";
args.Buttons = new DialogResult[] { DialogResult.OK, DialogResult.Cancel };
XtraMessageBox.Show(args);

//...
private void Args_Showing(object sender, XtraMessageShowingArgs e) {
    e.MessageBoxForm.Text = "Custom Text";
    e.Buttons[DialogResult.OK].Text = "Yes";
    e.Buttons[DialogResult.Cancel].Text = "No";
}

VB.NET

Dim args As New XtraMessageBoxArgs
AddHandler args.Showing, AddressOf Me.args_Showing
args.Caption = "Default Text"
args.Buttons = New DialogResult() {DialogResult.OK, DialogResult.Cancel}
XtraMessageBox.Show(args)

'. . .
Private Sub args_Showing(sender As Object, e As XtraMessageShowingArgs)
    e.MessageBoxForm.Text = "Custom Text"
    e.Buttons(DialogResult.OK).Text = "Yes"
    e.Buttons(DialogResult.Cancel).Text = "No"
End Sub

As a result, the displayed message box will have content and button captions that differ from those that were initially set.

See the XtraMessageBox article for more examples.

The following list shows the default parameters of the Show method overloads. You can override these parameters using a specific Show method overload.

• Caption - Empty string
• Buttons - MessageBoxButtons.OK
• Owner - null
• Icon - MessageBoxIcon.None
• DefaultButton - MessageBoxDefaultButton.Button1
• XtraMessageBox.AllowHtmlText - DefaultBoolean.Default

Example

This example demonstrates how to display the XtraMessageBox.

C#

using DevExpress.XtraEditors;
using DevExpress.Utils;

private void simpleButton1_Click(object sender, EventArgs e) {
    if(XtraMessageBox.Show("Do you want to close the <b>form</b>?", "Warning", MessageBoxButtons.YesNo, MessageBoxIcon.Warning, DefaultBoolean.True) == DialogResult.Yes)
        this.Close();
}

VB.NET

Imports DevExpress.XtraEditors
Imports DevExpress.Utils

Private Sub simpleButton1_Click(ByVal sender As Object, ByVal e As EventArgs)
    If XtraMessageBox.Show("Do you want to close the <b>form</b>?", "Warning", MessageBoxButtons.YesNo, MessageBoxIcon.Warning, DefaultBoolean.True) = DialogResult.Yes Then
        Me.Close()
    End If
End Sub