Prompt (NotesUIWorkspace - LotusScript®)

ダイアログボックスを表示し、ダイアログボックスでのアクションに基づく値を返します。

注: このメソッドは R5 で新しく追加されました。

定義位置

NotesUIWorkspace

構文

variant = notesUIWorkspace .Prompt( type%, title$, prompt$ [, default ] [, values ] )

パラメータ

type%

定数。表示するダイアログボックスの種類を示します。次のいずれかを指定します。

PROMPT_CHOOSEDATABASE (13)

注: Release 6.0 では定数名 PROMPT_CHOOSEDATABASE は実装されていませんが、代わりにリテラル値 13 を使用できます。

PROMPT_OK (1)

PROMPT_OKCANCELCOMBO (5)

PROMPT_OKCANCELEDIT (3)

PROMPT_OKCANCELEDITCOMBO (6)

PROMPT_OKCANCELLIST (4)

PROMPT_OKCANCELLISTMULT (7)

PROMPT_PASSWORD (10)

PROMPT_YESNO (2)

PROMPT_YESNOCANCEL (11)

title$

String 型。ダイアログボックスのタイトルバーに表示する文字列です。どの type% の場合でも必ず指定します。ただし、"" で null 文字列を指定することもできます。文字数の最大値は 65 です。

prompt$

String 型。ダイアログボックス内に表示する文字列です。どの type% の場合でも必ず指定します。ただし、"" で null 文字列を指定することもできます。文字数の最大値は 255 です。

default

デフォルトの入力値として使用する値です。ダイアログボックスの入力セクションには最初にこの値が入ります。ユーザーは [OK] を選択してこの値を受け入れるか、別の値で置き換えるか、[キャンセル] をクリックします。

type% が PROMPT_OK、PROMPT_YESNO、PROMPT_YESNOCANCEL、PROMPT_PASSWORD のダイアログボックスには適用できません。他のすべての type% の場合、省略可能です。ただし、PROMPT_OKCANCELCOMBO と PROMPT_OKCANCELEDITCOMBO の場合、default を使用して入力セクションを空白にしないことをお勧めします。

default として表示された値は、values リストに含めなければなりません。含まれていない場合は、無視されます。

PROMPT_OKCANCELEDIT、PROMPT_OKCANCELLIST、PROMPT_OKCANCELCOMBO、PROMPT_OKCANCELEDITCOMBO、PROMPT_OKCANCELLISTMULT のデフォルト値は、String 型、String 型の配列、String 形式の Variant 型、String 形式の Variant 型の配列のいずれかです。

values

ダイアログボックスのリストボックスに表示する値です。ユーザーはこの値の中から 1 つを入力値として選択できます。type% が PROMPT_OKCANCELLIST、PROMPT_OKCANCELCOMBO、PROMPT_OKCANCELEDITCOMBO、PROMPT_OKCANCELLISTMULT の場合のみ必要です。

PROMPT_OKCANCELLIST、PROMPT_OKCANCELCOMBO、PROMPT_OKCANCELEDITCOMBO、PROMPT_OKCANCELLISTMULT の値は、String 型の配列、String 形式の Variant 型、String 形式の Variant 型の配列のいずれかです。

戻り値

 

PROMPT_OK

Integer 形式の Variant 型。常に 1 を戻します。

 

PROMPT_YESNO

Integer 形式の Variant 型。はいの場合は 1 が返されます。いいえの場合は 0 が返されます。

 

PROMPT_YESNOCANCEL

Integer 形式の Variant 型。はいの場合は 1 が返されます。いいえの場合は 0 が返されます。キャンセルの場合は -1 が返されます。

 

PROMPT_OKCANCELEDIT

String 形式の Variant 型、または EMPTY。 はいの場合はユーザーが入力した値が返されます。キャンセルの場合は EMPTY が返されます。

 

PROMPT_OKCANCELLIST

String 形式の Variant 型、または EMPTY。 OK の場合はユーザーが選択した値が返されます。キャンセルの場合は EMPTY が返されます。

 

PROMPT_OKCANCELCOMBO

String 形式の Variant 型、または EMPTY。 OK の場合はユーザーが選択した値が返されます。キャンセルの場合は EMPTY が返されます。

 

PROMPT_OKCANCELEDITCOMBO

String 形式の Variant 型、または EMPTY。 OK の場合はユーザーが選択または入力した値が返されます。キャンセルの場合は EMPTY が返されます。

 

PROMPT_OKCANCELLISTMULT

String 形式の Variant 型配列、または EMPTY。OK の場合はユーザーが選択した 1 つ以上の値が返されます。キャンセルの場合は EMPTY が返されます。

 

PROMPT_PASSWORD

String 形式の Variant 型、または EMPTY。 OK の場合はユーザーが入力した値が返されます。キャンセルの場合は EMPTY が返されます。

 

PROMPT_CHOOSEDATABASE

String 形式の Variant 型配列、または EMPTY。戻り値は、3 つの要素からなる文字列の配列で、サーバー、ファイルパス、データベースのタイトルの順に含まれます。キャンセルの場合は EMPTY が返されます。

クロスリファレンス

式言語の @Prompt 関数