Skip to main content

XtraInputBox.Show(XtraInputBoxArgs) Method

Displays an input box with the specified settings.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v25.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

public static object Show(
    XtraInputBoxArgs args
)

Parameters

Name Type Description
args XtraInputBoxArgs

An XtraInputBoxArgs object that comprises dialog box settings.

Returns

Type Description
Object

The entered value, or null (Nothing in VB.NET) if nothing was entered.

Example

The following code snippet displays a dialog box with default settings:

WinForms Input Box with Default Settings, DevExpress

using DevExpress.XtraEditors;

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

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

The following code snippet displays an input box with the specified text, caption, and editor:

WinForms Input Box with Custom Settings, DevExpress

using DevExpress.XtraEditors;

// Create a DateEdit and customize its settings.
DateEdit dateEditor = new DateEdit();

dateEditor.Properties.CalendarView = DevExpress.XtraEditors.Repository.CalendarView.TouchUI;
dateEditor.Properties.Mask.EditMask = "MMMM d, yyyy";

// Initialize a new XtraInputBoxArgs instance with the specified settings.
XtraInputBoxArgs args = new XtraInputBoxArgs()
{
    Caption = "Shipping Options",
    Prompt = "Delivery Date",
    DefaultButtonIndex = 0,
    Editor = dateEditor,
    DefaultResponse = DateTime.Now.Date.AddDays(3) // The date editor's default value
};

// Display the input box and assign the dialog result to a variable.
var result = XtraInputBox.Show(args);
See Also