XtraInputBoxArgs.Prompt Property

Gets or sets the text to display in the dialog box.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

public string Prompt { get; set; }

VB.NET

Public Property Prompt As String

Property Value

Type	Description
String	A string value that specifies the text to display in the dialog box.

Remarks

Use the Prompt property to specify the text displayed above the dialog box editor. To provide an editor, use the XtraInputBoxArgs.Editor property.

The code snippet below shows how to display the dialog box using custom arguments.

C#

// initialize a new XtraInputBoxArgs instance 
XtraInputBoxArgs args = new XtraInputBoxArgs();
// set required Input Box options 
args.Caption = "Shipping options";
args.Prompt = "Delivery date";
args.DefaultButtonIndex = 0;
// initialize a DateEdit editor with custom settings 
DateEdit editor = new DateEdit();
editor.Properties.CalendarView = DevExpress.XtraEditors.Repository.CalendarView.TouchUI;
editor.Properties.Mask.EditMask = "MMMM d, yyyy";
args.Editor = editor;
// a default DateEdit value 
args.DefaultResponse = DateTime.Now.Date.AddDays(3);
// display an Input Box with the custom editor 
var result = XtraInputBox.Show(args).ToString();

VB.NET

' initialize a new XtraInputBoxArgs instance 
Dim args As New XtraInputBoxArgs()
' set required Input Box options 
args.Caption = "Shipping options" 
args.Prompt = "Delivery date" 
args.DefaultButtonIndex = 0
' initialize a DateEdit editor with custom settings 
Dim editor As New DateEdit()
editor.Properties.CalendarView = DevExpress.XtraEditors.Repository.CalendarView.TouchUI
editor.Properties.Mask.EditMask = "MMMM d, yyyy" 
args.Editor = editor
' a default DateEdit value 
args.DefaultResponse = Date.Now.Date.AddDays(3)
' display an Input Box with the custom editor 
Dim result = XtraInputBox.Show(args).ToString()

When an end-user clicks “OK” or “Yes”, the XtraInputBox.Show method returns an Object that is the editor’s edit value. Otherwise, the method returns null (Nothing in VB).