InputBox 関数

ダイアログ ボックスにメッセージとテキスト ボックスを表示し、文字列が入力されるか、またはボタンがクリックされると、テキスト ボックスの内容を返します。戻り値は文字列データ型です。

構文

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

InputBox 関数の構文には、次の引数があります。

引数	説明
prompt	必ず指定します。 ダイアログ ボックスにメッセージとして表示される文字列式。 プロンプトの最大長は、使用される文字の幅に応じて約 1024 文字です。 プロンプトが複数の行で構成されている場合は、復帰文字 (Chr(13))、改行文字 (Chr(10))、または復帰改行文字の組み合わせ (Chr(13) & Chr(10)) を使用して行を区切ることができます。
title	省略可能。 ダイアログ ボックスのタイトル バーに表示する文字列式を指定します。 タイトルを省略すると、アプリケーション名がタイトル バーに配置されます。
default	省略可能。 ユーザーが何も入力しない場合に、テキスト ボックスに既定値として表示する文字列式を指定します。 既定値を省略すると、テキスト ボックスは空で表示されます。
xpos	省略可能。 画面の左端からダイアログ ボックスの左端までの水平方向の距離を、twip 単位で示す数式を指定します。 xpos を省略すると、ダイアログ ボックスは水平方向に中央揃えされます。
ypos	省略可能。 画面の上端からダイアログ ボックスの上端までの垂直方向の距離を、twip 単位で示す数式を指定します。 ypos を省略すると、ダイアログ ボックスは画面の下方向の約 3 分の 1 の垂直方向に配置されます。
helpfile	省略可能。 ダイアログ ボックスに状況依存のヘルプを設定するために、使用するヘルプ ファイルを識別する文字列式を指定します。 helpfile が指定されている場合は、コンテキストも指定する必要があります。
context	省略可能。 ヘルプ作成者が該当するヘルプ トピックに割り当てたヘルプ コンテキスト番号を表す数式を指定します。 コンテキストが指定されている場合は、helpfile も指定する必要があります。

解説

ヘルプファイルとコンテキストの両方が指定されている場合、ユーザーは F1 (Windows) または HELP (Macintosh) を押して、コンテキストに対応するヘルプ トピックを表示できます。 一部のホスト アプリケーションでは、ダイアログ ボックスに [ヘルプ ] ボタンも自動的に追加されます。 [OK] をクリックするか、または Enter キーを押すと、InputBox 関数はテキスト ボックスの内容を返します。 ユーザーが [キャンセル] をクリックすると、長さ 0 の文字列 ("") が返されます。

例

この例は、InputBox 関数を使用して、ユーザーに値の入力を求めるメッセージを表示するさまざまな方法を示しています。 x 位置および y 位置を省略すると、ダイアログ ボックスは自動的に各軸の中央に表示されます。 変数 MyValue には、ユーザーが [OK] を クリックするか Enter キーを押した場合に入力された値が含まれます。 ユーザーが [キャンセル] をクリックした場合、長さ 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)