windowsforms-devexpress-dot-xtraeditors-dot-xtramessagebox-dot-show-x28-devexpress-dot-xtraeditors-dot-xtramessageboxargs-x29.md
Displays an XtraMessageBox with the specified settings.
Namespace : DevExpress.XtraEditors
Assembly : DevExpress.XtraEditors.v25.2.dll
NuGet Package : DevExpress.Win.Navigation
public static DialogResult Show(
XtraMessageBoxArgs args
)
Public Shared Function Show(
args As XtraMessageBoxArgs
) As DialogResult
| Name | Type | Description |
|---|---|---|
| args | XtraMessageBoxArgs |
An XtraMessageBoxArgs object that allows you to dynamically customize the displayed dialog.
|
| Type | Description |
|---|---|
| DialogResult |
A DialogResult enumerator value that specifies which message box button an end-user has clicked.
|
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.
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";
}
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.
| Parameter | Default Value | Property Name |
|---|---|---|
Caption | String.Empty | Caption |
Buttons | MessageBoxButtons.OK | Buttons |
DefaultButtonIndex | 0 | DefaultButtonIndex |
Owner | null | Owner |
Icon | MessageBoxIcon.None | ImageOptions |
The following code snippet displays the XtraMessageBox with formatted text and a warning icon. If the user clicks Yes , the application closes the current form.
using DevExpress.XtraEditors;
using DevExpress.Utils;
if(XtraMessageBox.Show(
"Do you want to close the <b>form</b>?", "Warning",
MessageBoxButtons.YesNo, MessageBoxIcon.Warning,
DefaultBoolean.True) == DialogResult.Yes)
this.Close();
Imports DevExpress.XtraEditors
Imports DevExpress.Utils
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
See Also