TextInputDialog.Show Method

Definition

Namespace:

Microsoft.VisualStudio.PlatformUI

Assembly:

Microsoft.VisualStudio.Shell.15.0.dll

Package:

Microsoft.VisualStudio.Shell.15.0 v17.12.40392

Overloads

Show(String, String, String, String)	Shows a text input dialog.
Show(String, String, String, Predicate<String>, String)	Shows a text input dialog.
Show(String, String, Int32, String, Predicate<String>, String)	Shows a text input dialog.

Show(String, String, String, String)

Shows a text input dialog.

public:
 static bool Show(System::String ^ title, System::String ^ prompt, System::String ^ defaultText, [Runtime::InteropServices::Out] System::String ^ % text);

public static bool Show (string title, string prompt, string defaultText, out string text);

static member Show : string * string * string * string -> bool

Public Shared Function Show (title As String, prompt As String, defaultText As String, ByRef text As String) As Boolean

Parameters

title

String

The title of the dialog.

prompt

String

The prompt text of the dialog.

defaultText

String

The default value of the dialog's input box.

text

String

When this method returns, this parameter contains the user's input text. If the user cancelled the dialog this parameter is null.

Returns

Boolean

True if the user submitted the text. False if the user cancelled the dialog.

Show(String, String, String, Predicate<String>, String)

Shows a text input dialog.

public:
 static bool Show(System::String ^ title, System::String ^ prompt, System::String ^ defaultText, Predicate<System::String ^> ^ validator, [Runtime::InteropServices::Out] System::String ^ % text);

public static bool Show (string title, string prompt, string defaultText, Predicate<string> validator, out string text);

static member Show : string * string * string * Predicate<string> * string -> bool

Public Shared Function Show (title As String, prompt As String, defaultText As String, validator As Predicate(Of String), ByRef text As String) As Boolean

Parameters

title

String

The title of the dialog.

prompt

String

The prompt text of the dialog.

defaultText

String

The default value of the dialog's input box.

validator

Predicate<String>

The predicate to evaluate whether the input should be accepted.

text

String

When this method returns, this parameter contains the user's input text. If the user cancelled the dialog this parameter is null.

Returns

Boolean

True if the user submitted the text. False if the user cancelled the dialog.

Show(String, String, Int32, String, Predicate<String>, String)

Shows a text input dialog.

public:
 static bool Show(System::String ^ title, System::String ^ prompt, int maxLength, System::String ^ defaultText, Predicate<System::String ^> ^ validator, [Runtime::InteropServices::Out] System::String ^ % text);

public static bool Show (string title, string prompt, int maxLength, string defaultText, Predicate<string> validator, out string text);

static member Show : string * string * int * string * Predicate<string> * string -> bool

Public Shared Function Show (title As String, prompt As String, maxLength As Integer, defaultText As String, validator As Predicate(Of String), ByRef text As String) As Boolean

Parameters

title

String

The title of the dialog.

prompt

String

The prompt text of the dialog.

maxLength

Int32

The maximum length of dialog's input.

defaultText

String

The default value of the dialog's input box.

validator

Predicate<String>

The predicate to evaluate whether the input should be accepted.

text

String

When this method returns, this parameter contains the user's input text. If the user cancelled the dialog this parameter is null.

Returns

Boolean

True if the user submitted the text. False if the user cancelled the dialog.