SaveFileDialog (NotesUIWorkspace - LotusScript®)

Gets a file name from the "Save As" dialog box.

Note: This method is new with Release 5.

Defined in

NotesUIWorkspace

Syntax

stringArray = notesUIWorkspace .SaveFileDialog( directoriesOnly , [title$] , [filters$] , [initialDirectory$] , [initialFile$] )

Parameters

directoriesOnly

Boolean.

  • True displays directories only.
  • False displays directories and files.

title$

String. Optional. Title for the dialog box. Defaults to "Save As."

filters$

String. Optional. User-defined string of filters that can limit the files displayed. For example, "Notes® Databases|*.nsf|Notes Templates|*.ntf" displays only files with the suffixes .nsf and .ntf. Undefined if parameter 1 is True.

You can specify multiple matching suffixes using ? wildcard and ; delimiter. For example:

"Windows Bitmaps|*.bmp|JPEG files|*.jpg;*.jpeg|NSx files|*.NS?|All files|*"
Note: ; can be used as a delimiter to list multiple matching patterns. In this case, the description of "JPEG files" means all files with the suffix "jpg" or "jpeg." The use of the "?" wildcard can represent any single character.

initialDirectory$

String. Optional. The directory to which the dialog box is opened. Otherwise, determined by system.

initialFile$

String. Optional. Default text for the selection box. Otherwise, no default text for the selection box.

Return value

stringArray

An array of type String.

  • (If the user clicks OK) the name of the selected file in the first element of the array.
  • (If the user clicks Cancel) the EMPTY value. IsEmpty is True.

Usage

This method returns a name. It does not save or perform any other action on files.

See OpenFileDialog for a variation.

Example