Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

XtraMessageBox.Show(XtraMessageBoxArgs) Method

Displays an XtraMessageBox with the specified settings.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v24.2.dll

NuGet Package: DevExpress.Win.Navigation

#Declaration

public static DialogResult Show(
    XtraMessageBoxArgs args
)

#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.

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";
}

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

Dialog - Showing args

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.

WinForms XtraMessageBox

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();
}
See Also