_Application.InputBox Method

  • Article

Displays a dialog box for user input. Returns the information entered in the dialog box.

Namespace:  Microsoft.Office.Interop.Excel
Assembly:  Microsoft.Office.Interop.Excel (in Microsoft.Office.Interop.Excel.dll)

Syntax

'Declaration
Function InputBox ( _
    Prompt As String, _
    Title As Object, _
    Default As Object, _
    Left As Object, _
    Top As Object, _
    HelpFile As Object, _
    HelpContextID As Object, _
    Type As Object _
) As Object
'Usage
Dim instance As _Application
Dim Prompt As String
Dim Title As Object
Dim Default As Object
Dim Left As Object
Dim Top As Object
Dim HelpFile As Object
Dim HelpContextID As Object
Dim Type As Object
Dim returnValue As Object

returnValue = instance.InputBox(Prompt, _
    Title, Default, Left, Top, HelpFile, _
    HelpContextID, Type)

Object InputBox(
    string Prompt,
    Object Title,
    Object Default,
    Object Left,
    Object Top,
    Object HelpFile,
    Object HelpContextID,
    Object Type
)

Parameters

  • Prompt
    Type: System.String

    Required Object. The message to be displayed in the dialog box. This can be a string, a number, a date, or a Boolean value.

  • Title
    Type: System.Object

    Optional Object. The title for the input box. If this argument is omitted, the default title is "Input."

  • Default
    Type: System.Object

    Optional Object. Specifies a value that will appear in the text box when the dialog box is initially displayed. If this argument is omitted, the text box is left empty. This value can be a Range object.

  • Left
    Type: System.Object

    Optional Object. Specifies an x position for the dialog box in relation to the upper-left corner of the screen in points.

  • Top
    Type: System.Object

    Optional Object. Specifies a y position for the dialog box in relation to the upper-left corner of the screen in points.

  • HelpFile
    Type: System.Object

    Optional Object. The name of the Help file for this input box. If the HelpFile and HelpContextID arguments are present, a Help button will appear in the dialog box.

  • HelpContextID
    Type: System.Object

    Optional Object. The context ID number of the Help topic in HelpFile.

  • Type
    Type: System.Object

    Optional Object. Specifies the return data type. If this argument is omitted, the dialog box returns text. Can be one or a sum of the following values.

    You can use the sum of the allowable values for Type. For example, for an input box that can accept both text and numbers, set Type to 1 + 2.

Return Value

Type: System.Object

Remarks

Use InputBox to display a simple dialog box so that you can enter information to be used in a macro. The dialog box has an OK button and a Cancel button. If you choose the OK button, InputBox returns the value entered in the dialog box. If you click the Cancel button, InputBox returns False.

If Type is 0, InputBox returns the formula in the form of text — for example, "=2*PI()/360". If there are any references in the formula, they are returned as A1-style references. (Use ConvertFormula to convert between reference styles.)

If Type is 8, InputBox returns a Range object.

If you use the InputBox method to ask the user for a formula, you must use the FormulaLocal property to assign the formula to a Range object. The input formula will be in the user's language.

The InputBox method differs from the InputBox function in that it allows selective validation of the user's input, and it can be used with Microsoft Excel objects, error values, and formulas. InputBox with no object qualifier calls the InputBox function.

See Also

Reference

_Application Interface

_Application Members

Microsoft.Office.Interop.Excel Namespace