Skip to main content
All docs
V24.1

XtraInputBox.Show(IWin32Window, String, String, String, XtraInputBox.Buttons) Method

Displays an XtraInputBox with the given parameters.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

public static string Show(
    IWin32Window owner,
    string prompt,
    string title,
    string defaultResponse,
    XtraInputBox.Buttons buttons
)

Parameters

Name Type Description
owner IWin32Window

The owner of the displayed Input Box.

prompt String

The text string displayed above an editor.

title String

The caption of the message window.

defaultResponse String

The initial editor value.

buttons XtraInputBox.Buttons

Specifies editor buttons.

Returns

Type Description
String

The value entered by a user, or null (Nothing in VB.NET) if no value was entered.

Remarks

The code below illustrates how to invoke an XtraInputBox with a SpinEdit editor.

XtraInputBox.Show(this, "Enter a required amount", "Input Box", 5, Buttons.OKCancel);

You can also use XtraInputBoxArgs objects to pass required Input Box settings.

The code snippet below shows how to display a dialog box with custom settings.

using DevExpress.XtraEditors;

// Display an iput box with the specifiedx prompt, title, and default response.
XtraInputBox.Show("Enter a new value", "Change Settings", "Default");
XtraInputBox.Show(this, "Enter a new value", "Change Settings", "Default");

// Initialize a new XtraInputBoxArgs instance.
XtraInputBoxArgs args = new XtraInputBoxArgs();
// Specify settings.
args.Caption = "Shipping options";
args.Prompt = "Delivery date";
args.DefaultButtonIndex = 0;
// Initialize a new DateEdit instance.
DateEdit editor = new DateEdit();
// Specify settings.
editor.Properties.CalendarView = DevExpress.XtraEditors.Repository.CalendarView.TouchUI;
editor.Properties.Mask.EditMask = "MMMM d, yyyy";
// Assign the editor to the input box settings.
args.Editor = editor;
// Specify the editor's default value.
args.DefaultResponse = DateTime.Now.Date.AddDays(3);
// Display an input box and assign the result to a variable.
var result = XtraInputBox.Show(args);

// You can also use the generic method and specify the return value's type.
DateTime resultDateTime = XtraInputBox.Show<DateTime>(args);
See Also