XtraInputBox.Show(XtraInputBoxArgs) Method

Displays an input box with the specified settings.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v19.2.dll

Declaration

C#

public static object Show(
    XtraInputBoxArgs args
)

VB.NET

Public Shared Function Show(
    args As XtraInputBoxArgs
) As Object

Parameters

Name	Type	Description
args	XtraInputBoxArgs	An XtraInputBoxArgs object that comprises dialog box settings.

Returns

Type	Description
Object	If OK or Yes is clicked, an Object that is the editor’s value. Otherwise, null (Nothing in VB).

Example

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

C#

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);

VB.NET

Imports 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(Me, "Enter a new value", "Change Settings", "Default")

' Initialize a new XtraInputBoxArgs instance.
Dim args As New XtraInputBoxArgs()
' Specify settings.
args.Caption = "Shipping options"
args.Prompt = "Delivery date"
args.DefaultButtonIndex = 0
' Initialize a new DateEdit instance.
Dim editor As 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 = Date.Now.Date.AddDays(3)
' Display an input box and assign the result to a variable.
Dim result = XtraInputBox.Show(args)

' You can also use the generic method and specify the return value's type.
Dim resultDateTime As Date = XtraInputBox.Show(Of Date)(args)