Topics

Clarified the autoHorzFit and autoVertFit parameters with respect to the layout region.

DialogBox method
Brings up a dialog box that displays the current document (either open or selected in a view) or a specified document using a form you specify. The dialog box shares fields with the underlying document. The user interacts with the dialog box as usual, clicking OK or Cancel when finished.

This function can be used with any form, but it's particularly useful with forms that contain a single layout region or table, because the user can interact with the layout region or table as if it were a dialog box.

Defined in
NotesUIWorkspace

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

Parameters
form$

String. The name of the form.

Boolean. Optional. Specify True if you want to scale the dialog box horizontally to fit the layout region. If you specify False or omit this parameter, the dialog box is not scaled horizontally.

Boolean. Optional. Specify True if you want to scale the dialog box vertically to fit the layout region. If you specify False or omit this parameter, the dialog box is not scaled vertically.

Boolean. Optional. Specify True if you want to display only an OK button. If you specify False or omit this parameter, both OK and Cancel buttons appear.

Boolean. Optional. Specify True if you don't want to add fields (that are on the dialog box form but not on the underlying form) to the underlying form. If you specify False or omit this parameter, all dialog box fields are passed to the underlying form.

Boolean. Optional. Specify True if you don't want to pass any edits from the dialog box to the underlying form (for example, if you're passing the edits somewhere else in a Queryclose script for the dialog box form). If you specify False or omit this parameter, the edits are passed to the underlying form.

Boolean. Optional. Specify True if you want to prohibit writing to the dialog box (for example, if you are using the dialog box to display a help screen). If you specify False or omit this parameter, the dialog box is read-write. This option makes noCancel true.

String. Optional. A title for the dialog box. Defaults to "Lotus Notes."

NotesDocument. Optional. A document to be opened instead of the current document.

Note This parameter is new with Release 5.

Boolean. Optional. Specify True if you want to scale a table to fit into the dialog box. If you specify False or omit this parameter, the table is not scaled to fit the dialog box.

Note This parameter is new with Release 5.

Boolean. Optional. Specify True if you do not want to display the OK and Cancel buttons. If you specify False or omit this parameter, both OK and Cancel buttons appear. This parameter is dependent upon the noCancel parameter. If the noCancel parameter is False, the noOkCancel parameter is ignored.

Boolean. Returns True if the user clicks OK in the dialog box. Returns False if the user clicks Cancel.

• Use both parameters.
• In the layout region InfoBox, deselect Display Border and select 3D style.

• If the form has field names in common with the document, the field values of the document are displayed in the dialog box.
• If the user changes the value of any fields in the dialog box and clicks OK, the changes are reflected in the same fields on the document.
• If the user enters a value for a field in the dialog box, and the document does not contain a field by that name, the value is added to the document, even if it is not displayed in the form, unless noNewFields is True.