DialogBox (NotesUIWorkspace - LotusScript®)

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

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

定義位置

NotesUIWorkspace

構文

flag = notesUIWorkspace .DialogBox( form$ , [autoHorzFit] , [autoVertFit] , [noCancel] , [noNewFields] , [noFieldUpdate] , [readOnly] , [title$] , [notesDocument] , [sizeToTable] , [noOkCancel] , [okCancelAtBottom] )

パラメータ

form$

String 型。フォームの名前です。

autoHorzFit

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

autoVertFit

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

noCancel

Boolean 型。オプション。[キャンセル] ボタンを表示しないようにするには True を指定します。指定しない場合、ダイアログボックスに [キャンセル] ボタンが表示されます。

noNewFields

Boolean 型。オプション。フィールド (ダイアログボックスフォームにはあるが基になる文書にはないフィールド) を追加したくないときには True を指定します。指定しない場合、ダイアログボックスのフィールドがすべて基の文書に渡されます。

noFieldUpdate

Boolean 型。オプション。基になる文書にダイアログボックスから一切の編集内容を渡したくないときには True を指定します (例えば、ダイアログボックスフォームの Queryclose スクリプトの編集内容をほかへ渡す場合など)。指定しない場合、編集内容が基の文書に渡されます。

readOnly

Boolean 型。オプション。ダイアログボックスへの書き込みを禁止したいときには True を指定します (例えば、ダイアログボックスをヘルプ画面の表示に使用している場合など)。指定しない場合、ダイアログボックスは読み書き可能になります。このオプションによって noCancel は True になります。

title$

String 型。オプション。ダイアログボックスのタイトルです。デフォルトは「Notes」です。

notesDocument

NotesDocument. オプション。現在の文書の代わりに開かれる文書です。

sizeToTable

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

Boolean 型。オプション。フォームの最初のテーブルに autoHorzFit と autoVertFit を適用させるには True を指定します。指定しない場合、フォームの最初のレイアウト領域に適用されます。

noOkCancel

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

Boolean 型。オプション。[OK] ボタンを表示しないようにするときには True を指定します。指定しない場合、ダイアログボックスに [OK] ボタンが表示されます。このパラメータを指定すると、ダイアログボックスの変更内容が現在の文書に反映されません。変更内容を現在の文書に反映させ、[OK] ボタンを表示しないようにするには、RefreshParentNote メソッドを使用します。

okCancelAtBottom

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

Boolean 型。オプション。ダイアログボックスの最下部に [OK] と [キャンセル] ボタンを並べて表示するには True を指定します。False を指定するかこのパラメータを省略すると、ボタンは先頭に重ねて表示されます。

戻り値

flag

Boolean 型。ダイアログボックスで [OK] をクリックすると True を返します。[キャンセル] をクリックすると False を返します。

使用法

autoHorzFit と autoVertFit パラメータを使用すれば、フォームの残りの部分を表示することなく、レイアウト領域全体 (sizeToTable が False の場合) またはテーブル (sizeToTable が True の場合) をダイアログボックスに表示できます。フォームにレイアウト領域またはテーブルが複数あるときは、最初のレイアウト領域またはテーブルだけが表示されます。最善の結果を得るには、次のようにします。

autoHorzFit と autoVertFit の両方を使用します。
[レイアウト] プロパティボックスで、[境界線の表示] の選択を解除して [3D スタイル] を選択します。

autoHorzFit と autoVertFit のどちらにも False が指定されている場合は、フォーム全体が使用され、サイズ変更は行われません。フォームにレイアウト領域 (sizeToTable が False の場合) またはテーブル (sizeToTable が True の場合) が含まれていない場合、フォーム全体が使用され、サイズ変更は行われません。

フィールド値を共有する

このメソッドは異なるフォームを使用して現在の文書や指定の文書を表示します。これは、次のことを意味します。

form が文書のフィールドと同じ名前のフィールドを持つときは、文書のフィールド値がダイアログボックスに表示されます。
ユーザーがダイアログボックスでフィールドの値を変更して [OK] をクリックすると、その変更は文書内の同じフィールドに反映されます。
ユーザーがフィールドの値をダイアログボックスに入力するときに、その名前のフィールドが文書に含まれていない場合、フォームに表示されなくても noNewFields が True でなければその値は文書に追加されます。

リッチテキストフィールドでは、フィールドの共有はサポートされません。

クロスリファレンス

式言語の @DialogBox 関数

例