Interaction.InputBox Method (String, String, String, Int32, Int32)
Note |
|---|
The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience. |
Displays a prompt in a dialog box, waits for the user to input text or click a button, and then returns a string containing the contents of the text box.
Assembly: Microsoft.VisualBasic (in Microsoft.VisualBasic.dll)
[HostProtectionAttribute(SecurityAction.LinkDemand, Resources = HostProtectionResource.UI)] public static string InputBox( string Prompt, string Title = "", string DefaultResponse = "", int XPos = -1, int YPos = -1 )
Parameters
- Prompt
-
Type:
System.String
Required String expression displayed as the message in the dialog box. The maximum length of Prompt is approximately 1024 characters, depending on the width of the characters used. If Prompt consists of more than one line, you can separate the lines using a carriage return character (Chr(13)), a line feed character (Chr(10)), or a carriage return/line feed combination (Chr(13) & Chr(10)) between each line.
- Title
-
Type:
System.String
Optional. String expression displayed in the title bar of the dialog box. If you omit Title, the application name is placed in the title bar.
- DefaultResponse
-
Type:
System.String
Optional. String expression displayed in the text box as the default response if no other input is provided. If you omit DefaultResponse, the displayed text box is empty.
- XPos
-
Type:
System.Int32
Optional. Numeric expression that specifies, in twips, the distance of the left edge of the dialog box from the left edge of the screen. If you omit XPos, the dialog box is centered horizontally.
- YPos
-
Type:
System.Int32
Optional. Numeric expression that specifies, in twips, the distance of the upper edge of the dialog box from the top of the screen. If you omit YPos, the dialog box is positioned vertically approximately one-third of the way down the screen.
Return Value
Type: System.StringDisplays a prompt in a dialog box, waits for the user to input text or click a button, and then returns a string containing the contents of the text box.
If the user clicks Cancel, a zero-length string is returned.
To specify more than the first argument, you must use the InputBox function in an expression. If you omit any positional arguments, you must retain the corresponding comma delimiter.
Note |
|---|
The InputBox function requires UIPermission at the SafeTopLevelWindows level, which may affect its execution in partial-trust situations. For more information, see and UIPermission . |
This example shows various ways to use the InputBox function to prompt the user to enter a value. If the x and y positions are omitted, the dialog box is automatically centered for the respective axes. The variable MyValue contains the value entered by the user if the user clicks OK or presses the ENTER key.
Dim message, title, defaultValue As String Dim myValue As Object ' Set prompt. message = "Enter a value between 1 and 3" ' Set title. title = "InputBox Demo" defaultValue = "1" ' Set default value. ' Display message, title, and default value. myValue = InputBox(message, title, defaultValue) ' If user has clicked Cancel, set myValue to defaultValue If myValue Is "" Then myValue = defaultValue ' Display dialog box at position 100, 100. myValue = InputBox(message, title, defaultValue, 100, 100) ' If user has clicked Cancel, set myValue to defaultValue If myValue Is "" Then myValue = defaultValue
Available since 1.1
