ユーザーが入力できるようなプロンプトを持つダイアログボックスを表示して、ユーザーからの入力を文字列として返します。

構文

InputBox[$] ( prompt [ , [ title ] [ , [ default ] [ , xpos , ypos ] ] ] )

要素

プロンプト

文字列式。ダイアログボックスに表示されるメッセージ。prompt の長さは任意です。LotusScript ではサポートされる最小限の長さとして 128 文字を定義していますが、強制ではありません。使用されている製品 (Lotus Notes や ESB など) によっては、他に制限が設けられている場合があります。

省略可能。文字列式。ダイアログボックスのタイトルバーに表示されます。title の長さは任意です。LotusScript ではサポートされる最小限の長さとして 128 文字を定義していますが、強制ではありません。使用されている製品 (Lotus Notes や ESB など) によっては、他に制限が設けられている場合があります。

title を省略すると、タイトルバーには何も表示されません。title を省略して default または xpos と ypos を指定するときは、title の代わりにカンマを使用してください。

省略可能。文字列式。ユーザーが既定で応答できるようにダイアログボックスのテキスト入力フィールドに表示されます。default の長さは任意です。LotusScript では、サポートされる最小限の長さとして 512 文字を定義していますが、これは必須ではありません。使用する製品 (Lotus Notes や ESB など) によっては、別の制限が設定されている場合があります。

default を省略すると、テキスト入力ボックスには何も表示されません。default を省略して xpos と ypos を指定するときは、default の代わりにカンマを使用してください。

省略可能。ディスプレイの左端からダイアログボックスの左端までの水平方向距離を 1 ピクセル単位で指定する数式です。xpos を省略すると、距離はゼロになります。xpos を指定するときは、ypos も指定しなければなりません。

省略可能。ディスプレイの上端からダイアログボックスの上端までの垂直方向距離を 1 ピクセル単位で指定する数式です。ypos を省略すると、距離はゼロになります。ypos を指定するときは、xpos も指定しなければなりません。

InputBox 関数は、文字列を含んだ Variant 型を返します。InputBox$ は String 型を返します。返される文字列の長さは決まっていません。LotusScript では、サポートされる最小限の長さとして 512 文字を定義していますが、これは必須ではありません。使用する製品 (Lotus Notes や ESB など) によっては、別の制限が設定されている場合があります。

使用法

InputBox は、[OK] ボタン、[キャンセル] ボタン、およびテキスト入力フィールドを含んだダイアログボックスを表示し、どちらかのボタンがクリックされてテキスト入力が確認されるまでスクリプトの実行を中断します。次に、そのエントリを返します。[キャンセル] がクリックされると、空の文字列 ("") を返します。[OK] または [キャンセル] がクリックされると、実行を再開します。

実行している Lotus ソフトウェアによっては、prompt、title、default、またはテキスト入力フィールドに、上記の値よりも長い文字列を入力できることがあります。Lotus ソフトウェアがサポートしていれば、これらの項目に上限サイズまでの文字列を使用できます。

Lotus Notes の中から LotusScript を使用している場合、InputBox 関数は以下のものに書き込むことに注意してください。

• Lotus Notes クライアントで実行するときはダイアログボックス。ユーザーが [OK]、[キャンセル]、[中止]、[再試行]、[はい]、[いいえ] のどれかをクリックすると処理が続行します。
• Lotus Domino サーバー上で実行している場合は NOTES.LOG が出力先になります。

式言語の @Prompt 関数

例
関連項目

LotusScript ランゲージリファレンス: I - L
MessageBox 関数とステートメント
Print ステートメント

用語集