InputBox Function

Description

Displays a prompt in a dialog box, waits for the user to input text or choose a button, and returns the contents of the text box.

Syntax

InputBox(prompt[,title][,default][,xpos][,ypos][,helpfile,context])

The InputBox function syntax has these named-argument parts:

Part	Description

*prompt*	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, be sure to include a carriage return (character code 13), or carriage return linefeed (character code 10) between each line.
*title*	String expression displayed in the title bar of the dialog box. If you omit *title*, nothing is placed in the title bar.
*default*	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.
*xpos*	Numeric expression 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.
*ypos*	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.
*helpfile*	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.
*context*	Numeric expression that is the Help context number the Help author assigned to the appropriate Help topic. If *context* is provided, *helpfile* must also be provided.

Remarks

When both helpfile and context are supplied, a Help button is automatically added to the dialog box.

If the user chooses OK or presses Enter, the InputBox function returns whatever is in the text box. If the user chooses Cancel, the function returns a zero-length string ("").

In Microsoft Excel, the prompt string cannot contain more than 256 characters.

See Also

MsgBox Function.

Example

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 is automatically centered for the respective axes. The variable MyValue contains the value entered by the user if the user chooses OK or presses ENTER. If the user chooses Cancel, a zero-length string is returned.

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 = InputBox(Message, Title, Default)

' Use helpfile and context. The help button is added automatically.
MyValue = InputBox(Message, Title, , , , "DEMO.HLP", 10)

' Display dialog at position 100,100
MyValue = InputBox(Message, Title, Default, 100, 100)