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

Displays an XtraInputBox with the given parameters.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v26.1.dll

Declaration

C#

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

VB.NET

Public Shared Function Show(
    prompt As String,
    title As String,
    defaultResponse As String,
    buttons As XtraInputBox.Buttons
) As String

Parameters

Name	Type	Description
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 if no value was entered.

Remarks

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

C#

XtraInputBox.Show("Select a date", "Jump to Date", DateTime.Now, Buttons.OKCancel);

VB.NET

XtraInputBox.Show("Select a date", "Jump to Date", Date.Now, Buttons.OKCancel)

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

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

C#

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

VB.NET

Imports DevExpress.XtraEditors

' Display an input box with the specified owner, 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(Me, "Enter a new value", "Change Settings", "Default")

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

C#

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

VB.NET

Imports DevExpress.XtraEditors

' Create a DateEdit and customize its settings.
Dim dateEditor As 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.
Dim args As New XtraInputBoxArgs() With {
    .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.
Dim result = XtraInputBox.Show(args)