Interaction.InputBox Method

'Declaration
Public Shared Function InputBox ( _
	Prompt As String, _
	<OptionalAttribute> Optional Title As String = "", _
	<OptionalAttribute> Optional DefaultResponse As String = "", _
	<OptionalAttribute> Optional XPos As Integer = -1, _
	<OptionalAttribute> Optional YPos As Integer = -1 _
) As String
'Usage
Dim Prompt As String
Dim Title As String
Dim DefaultResponse As String
Dim XPos As Integer
Dim YPos As Integer
Dim returnValue As String

returnValue = Interaction.InputBox(Prompt, Title, DefaultResponse, XPos, YPos)

public static String InputBox (
	String Prompt, 
	/** @attribute OptionalAttribute() */ String Title, 
	/** @attribute OptionalAttribute() */ String DefaultResponse, 
	/** @attribute OptionalAttribute() */ int XPos, 
	/** @attribute OptionalAttribute() */ int YPos
)

public static function InputBox (
	Prompt : String, 
	Title : String, 
	DefaultResponse : String, 
	XPos : int, 
	YPos : int
) : String

Not applicable.

Parameters

Prompt

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

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

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

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

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

For more detailed information, see the Visual Basic topic InputBox Function (Visual Basic).

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 Requesting Permissions and UIPermission Class.

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

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

.NET Compact Framework