XtraInputBox.Show(String, String, String) Method

Displays an input box with the specified title, prompt, and default response.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v26.1.dll

Declaration

C#

public static string Show(
    string prompt,
    string title,
    string defaultResponse
)

VB.NET

Public Shared Function Show(
    prompt As String,
    title As String,
    defaultResponse As String
) As String

Parameters

Name	Type	Description
prompt	String	The text above the editor.
title	String	The text in the title bar.
defaultResponse	String	The text that is the editor’s default value.

Returns

Type	Description
String	The entered value, or null if nothing was entered.

Example

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)

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Show(String, String, String) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-chat-for-net-framework/CS/DevExpress.AI.WinForms.HtmlChat.Demo/Program.cs#L68

if(string.IsNullOrEmpty(environmentVariable) && allowSetNewEnvironmentVariable) {
    environmentVariable = XtraInputBox.Show($"Please enter {variableName} variable.", variableName, string.Empty);
    if(string.IsNullOrEmpty(environmentVariable))

winforms-generate-skin-palettes-with-ai/CS/DevExpress.AI.WinForms.AIGeneratePalette.Demo/AI/ChatClientFactory.cs#L75

if(string.IsNullOrEmpty(environmentVariable) && allowSetNewEnvironmentVariable) {
    environmentVariable = XtraInputBox.Show($"Please enter {variableName} variable.", variableName, string.Empty);
    if(string.IsNullOrEmpty(environmentVariable))