ダイアログ ボックスにメッセージとテキスト ボックスを表示し、文字列が入力されるか、またはボタンがクリックされると、テキスト ボックスの内容を返します。戻り値は文字列データ型です。
構文
InputBox ( prompt [, title ] [, default ] [, xpos ] [, ypos ] [, helpfile ] [, context ] )
InputBox 関数の構文には、次の引数があります。
引数 | 説明 |
|---|---|
|
prompt |
必須。ダイアログ ボックス内にメッセージとして表示する文字列式を指定します。引数 prompt に指定できる最大文字数は、約 1,024 文字です。ただし、使用する文字の文字幅に依存します。引数 prompt に複数行を指定するには、改行する場所にキャリッジ リターン (Chr(13))、ラインフィード (Chr(10))、またはキャリッジ リターンとラインフィードの組み合わせ (Chr(13) & Chr(10)) を挿入します。 |
|
タイトル |
省略可能。ダイアログ ボックスのタイトル バーに表示する文字列式を指定します。引数 title を省略すると、タイトル バーにはアプリケーション名が表示されます。 |
|
default |
省略可能。ユーザーが何も入力しない場合に、テキスト ボックスに既定値として表示する文字列式を指定します。default を省略すると、テキスト ボックスには何も表示されません。 |
|
xpos |
省略可能。画面の左端からダイアログ ボックスの左端までの水平方向の距離を、twip 単位で示す数式を指定します。xpos を省略すると、ダイアログ ボックスは水平方向に対して画面の中央の位置に配置されます。 |
|
ypos |
省略可能。画面の上端からダイアログ ボックスの上端までの垂直方向の距離を、twip 単位で示す数式を指定します。ypos を省略すると、ダイアログ ボックスは垂直方向に対して画面の上端から約 1/3 の位置に配置されます。 |
|
helpfile |
省略可能。ダイアログ ボックスに状況依存のヘルプを設定するために、使用するヘルプ ファイルを識別する文字列式を指定します。引数 helpfile を指定した場合は、引数 context も指定する必要があります。 |
|
context |
省略可能。ヘルプ作成者が該当するヘルプ トピックに割り当てたヘルプ コンテキスト番号を表す数式を指定します。引数 context を指定した場合は、引数 helpfile も指定する必要があります。 |
解説
引数 helpfile と context の両方を指定すると、ユーザーは F1 キー (Windows) または HELP キー (Macintosh) を押して context に対応するヘルプ トピックを参照できます。たとえば Microsoft Office Excel 2007 などのホスト アプリケーションでは、自動的にダイアログ ボックスに [ヘルプ] ボタンが追加されます。[OK] をクリックするか、または Enter キーを押すと、InputBox 関数はテキスト ボックスの内容を返します。ユーザーが [キャンセル] をクリックすると、長さ 0 の文字列 ("") が返されます。
注: 名前付き引数 prompt 以外の引数も指定する場合は、式の中で InputBox 関数を使用する必要があります。引数を省略するには、それに対応する位置にコンマ区切り記号を記述します。
例
注: 次の例は、Visual Basic for Applications (VBA) モジュールでのこの関数の使用方法を示しています。 VBA の使用方法の詳細については、[検索] の横にあるドロップダウン リストで [開発者用リファレンス] を選び、検索ボックスに検索する用語を入力します。
この例は、InputBox 関数を使用して、ユーザーに値の入力を求めるメッセージを表示するさまざまな方法を示しています。x 位置および y 位置を省略すると、ダイアログ ボックスは自動的に各軸の中央に表示されます。ユーザーが [OK] をクリックするか、Enter キーを押した場合、変数 MyValue にはユーザーが入力した値が格納されます。ユーザーが [キャンセル] をクリックした場合、長さ 0 の文字列が返されます。
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 = InputBox(Message, Title, Default)
' Use Helpfile and context.
' The Help button is added automatically.
MyValue = InputBox(Message, Title,,,,"DEMO.HLP", 10)
' Display dialog box at position 100, 100.
MyValue = InputBox(Message, Title, Default, 100, 100)
