@DialogBox (式言語)

現在の文書 (開いている、またはビューで選択されている文書) をダイアログボックスに表示します。ダイアログボックスは、基になる文書のフィールドを共有します。ユーザーはダイアログボックスを通常どおりに使用し、[OK] または [キャンセル] をクリックして終了します。

この関数は任意のフォームで使用できますが、フォームが単一のテーブルまたはレイアウト領域を含むときは、ユーザーはダイアログボックスのように扱うことができるので特に便利です。

構文

@DialogBox( form ; [AUTOHORZFIT] : [AUTOVERTFIT] : [NOCANCEL] : [NONEWFIELDS] : [NOFIELDUPDATE] : [READONLY] : [SIZETOTABLE] : [NOOKCANCEL] : [OKCANCELATBOTTOM] : [NONOTE] ; title )

パラメータ

form

文字列。フォームの名前です。

[AUTOHORZFIT]

キーワード。オプション。フォームの最初のレイアウト領域または表に合うよう水平方向にダイアログボックスを伸縮します。指定しない場合、ダイアログボックスは水平方向に伸縮されません。

[AUTOVERTFIT]

キーワード。オプション。フォームの最初のレイアウト領域または表に合うよう垂直方向にダイアログボックスを伸縮します。指定しない場合、ダイアログボックスは垂直方向に伸縮されません。

[NOCANCEL]

キーワード。オプション。[キャンセル] ボタンを表示しません。指定しない場合、ダイアログボックスに [キャンセル] ボタンが表示されます。

[NONEWFIELDS]

キーワード。オプション。ダイアログボックスのフォームにはあって基になるフォームにはないフィールドを、基のフォームの文書に追加しません。指定しない場合、ダイアログボックスのフィールドがすべて基の文書に渡されます。

[NOFIELDUPDATE]

キーワード。オプション。ダイアログボックスのフィールドでの編集内容を基になる文書に渡しません。例えば、ダイアログボックスフォームの QueryClose スクリプトで編集内容を他へ渡す場合などに使用します。指定しない場合、編集内容が基の文書に渡されます。

[READONLY]

キーワード。オプション。ダイアログボックスへの書き込みを禁止します。例えば、ダイアログボックスを使用してヘルプ画面を表示する場合などに使用します。指定しない場合、ダイアログボックスは読み書き可能になります。このキーワードを使用するとき、[NoCancel] が暗黙的に指定されます。

[SIZETOTABLE]

注: このパラメータは R5 で新しく追加されました。

キーワード。オプション。[AUTOHORZFIT] と [AUTOVERTFIT] をフォームの最初の表に適用します。指定しない場合、フォームの最初のレイアウト領域に適用されます。

[NOOKCANCEL]

注: このパラメータは R5 で新しく追加されました。

キーワード。オプション。[OK] ボタンを表示しません。指定しない場合、ダイアログボックスに [OK] ボタンが表示されます。このキーワードを指定すると、ダイアログボックスでの変更は現在の文書に反映されません。[OK] ボタンを表示せずに現在の文書を更新できるようにするには、RefreshParentNote @コマンドを実行するホットスポットボタンを追加します。

[OKCANCELATBOTTOM]

注: このパラメータは R6 で新しく追加されました。

キーワード。オプション。ダイアログボックスの末尾に、[OK] ボタンか [キャンセル] ボタン、またはその両方を並べて表示します。これを指定しないと、これらのボタンが先頭に近い位置に重ねて表示されます。

[NONOTE]

注: このパラメータは Release 7 で新しく追加されました。

キーワード。オプション。現在の文書を使用せずに @Dialogbox 関数を使用できます。現在の文書が存在する場合は、無視されます。このキーワードを使用すると [NOFIELDUPDATE] と [NONEWFIELDS] が、明示的に指定されていなくても含まれます。このキーワードを使用すると、基になる文書からダイアログボックスに値が渡されず、表示されている値のみが式のデフォルト値になります。[NONOTE] パラメータが指定されていなければ、現在の文書が必要です。

title

文字列。ダイアログボックスのタイトルです。デフォルトは「Notes」です。

戻り値

number

ユーザーが [OK] をクリックした場合は @True (1)、それ以外の場合は @False (0) です。ユーザーが [OK] をクリックすると、[NOFIELDUPDATE] または [NONOTE] が有効な場合を除いて、対応するフィールドが更新されます (後述の「フィールド値を共有する」を参照してください)。

使用法

この関数は、アクションのボタンで使用すると便利です。列式、選択式、サーバー上で実行されるエージェント (メールエージェントとスケジュール設定されたエージェント) では使用できません。ウィンドウタイトル式やフォーム式でも使用できません。この関数は任意のフォームで使用できますが、フォームが単一のテーブルまたはレイアウト領域を含むときは、ユーザーはダイアログボックスのように扱うことができるので特に便利です。

@DialogBox では、リッチテキストフィールドのデータは返されません。

この関数は、Web アプリケーションでは使用できません。

form にアクションバーのアクションが含まれている場合、そのアクションはダイアログボックスには表示されません。

[AUTOHORZFIT] と [AUTOVERTFIT] を使用すると、レイアウト領域 ([SIZETOTABLE]) を使用しない場合) または表 ([SIZETOTABLE] を使用する場合) 全体がダイアログボックスに表示され、フォームの残りの部分は表示されません。フォームにレイアウト領域またはテーブルが複数あるときは、最初のレイアウト領域またはテーブルだけが表示されます。最善の結果を得るには、次のようにします。

[AUTOHORZFIT] と [AUTOVERTFIT] を両方とも省略すると、フォーム全体が使用され、サイズ変更は行われません。フォームにレイアウト領域 ([SIZETOTABLE] を指定しない場合) または表 ([SIZETOTABLE] を指定する場合) が含まれていない場合は、フォーム全体が使用され、サイズ変更は行われません。

フィールド値を共有する

@DialogBox では、現在の文書が別のフォームを使用して表示されます。これは、次のことを意味します。

例

  1. [Profile] というフォームのボタンに、次の式が定義されています。
    @DialogBox("Profile Options"; [AUTOHORZFIT] : [AUTOVERTFIT] )

    [Profile] と [Profile Options] の両方に、[Comments] というフィールドがあります。ユーザーがボタンをクリックすると、[Profile Options] フォームを使用してダイアログボックスに文書が表示されます。ダイアログボックスは、[Profile Options] のレイアウト領域に収まるよう大きさが調整されます。

    ユーザーは、このダイアログボックスで [Comments] フィールドを編集するなどの操作ができます。

    ユーザーは [OK] をクリックします。編集モードであれば、[Comments] フィールドに対する変更は文書に反映されます。

  2. 次の式は [Help screen] というフォームを読み込み専用で表示します。
    @DialogBox("Help screen"; [AUTOHORZFIT] : [AUTOVERTFIT] : [NOCANCEL] : [NONEWFIELDS] : [READONLY]; "Help")
  3. 次の式は、フォームの表のサイズをダイアログボックスに合わせて変更し、[OK] ボタンは表示しません。
    @DialogBox( "Table Test" ; [AUTOHORZFIT] : [AUTOVERTFIT] : [SIZETOTABLE] : [NOOKCANCEL])

  4. 次の式では、[Provide information] というダイアログボックスに [info] フォームが表示されます。このダイアログボックスにはボタンはありません。このフォームを閉じて現在の文書に戻るには、ダイアログボックス右上の [閉じる] アイコンをクリックしなければなりません。
    @DialogBox("info";[NOCANCEL]:[NOOKCANCEL];"Provide information")

クロスリファレンス

LotusScript® NotesUIWorkspace クラスの DialogBox メソッド

親トピック: 式言語: @ 関数リファレンス
関連概念:
@DialogBox でフォームに記入する
関連資料:
DialogBox (NotesUIWorkspace - LotusScript)
@PickList (式言語)
@Prompt (式言語)
RefreshParentNote @コマンド (式言語)