Displays a prompt in a dialog box, waits for the user to input text or click a button, and returns a String (String data type: A fundamental data type that holds characters, one character per 2 bytes. A fixed-length string can contain 1 to 64K characters; a variable-length string can contain 1 to 2 billion.) containing the contents of the text box.
InputBox(prompt [, title ] [, default ] [, xpos ] [, ypos ] [, helpfile ] [, context ] )
The InputBox function syntax has these arguments (argument: A value that provides information to an action, an event, a method, a property, a function, or a procedure.):
||Required. String expression (string expression: An expression that evaluates to a sequence of contiguous characters. Elements of the expression can be: functions that return a string or a string Variant (VarType 8); a string literal, constant, variable, or Variant.) 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 linefeed character (Chr(10)), or carriage return–linefeed character combination (Chr(13) & Chr(10)) between each line.
||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.
||Optional. String expression displayed in the text box as the default response if no other input is provided. If you omit default, the text box is displayed empty.
||Optional. Numeric expression (numeric expression: Any expression that evaluates to a number. The expression can be any combination of variables, constants, functions, and operators.) that specifies, in twips, the horizontal distance of the left edge of the dialog box from the left edge of the screen. If xpos is omitted, the dialog box is horizontally centered.
||Optional. Numeric expression that specifies, in twips, the vertical distance of the upper edge of the dialog box from the top of the screen. If ypos is omitted, the dialog box is vertically positioned approximately one-third of the way down the screen.
||Optional. String expression that identifies the Help file to use to provide context-sensitive Help for the dialog box. If helpfile is provided, context must also be provided.
||Optional. Numeric expression that is the Help context number assigned to the appropriate Help topic by the Help author. If context is provided, helpfile must also be provided.
When both helpfile and context are provided, the user can press F1 (Windows) or HELP (Macintosh) to view the Help topic corresponding to the context. Some host application (host application: Any application that supports the use of Visual Basic for Applications.), for example, Microsoft Office Excel 2007, also automatically add a Help button to the dialog box. If the user clicks OK or presses ENTER , the InputBox function returns whatever is in the text box. If the user clicks Cancel, the function returns a zero-length string ("").
Note To specify more than the first named argument, you must use InputBox in an expression (expression: Any combination of mathematical or logical operators, constants, functions, and names of fields, controls, and properties that evaluates to a single value. Expressions can perform calculations, manipulate characters, or test data.). To omit some positional arguments (argument: A value that provides information to an action, an event, a method, a property, a function, or a procedure.), you must include the corresponding comma delimiter.
Note Examples that follow demonstrate the use of this function in a Visual Basic for Applications (VBA) module. For more information about working with VBA, select Developer Reference in the drop-down list next to Search and enter one or more terms in the search box.
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
contains the value entered by the user if the user clicks OK
or presses the ENTER key . If the user clicks Cancel
, a zero-length string is returned.
Dim Message, Title, Default, MyValue
Message = "Enter a value between 1 and 3" ' Set prompt.
Title = "InputBox Demo" ' Set title.
Default = "1" ' Set default.
' Display message, title, and default value.
MyValue = Message Title Default
' Use Helpfile and context.
' The Help button is added automatically.
MyValue = Message Title"DEMO.HLP" 10
' Display dialog box at position 100, 100.
MyValue = Message Title Default 100 100