File

Methods

(inner) fileCloseWindow() → {void}

Closes the current application window. Same as the FileCloseWindow command

See
Returns:
Type: 
void

(inner) fileDatabaseACL()

Displays the access control list for the current database.

Throws:

No plans to implement

Type
Error

(inner) fileDatabaseCompact()

Compacts the white space in a database, and at the same time, converts the old database to the new format.

Throws:

No plans to implement

Type
Error

(inner) fileDatabaseCopy()

Displays the Copy Database dialog box, where the user can copy the current database to a new location.

Throws:

No plans to implement

Type
Error

(inner) fileDatabaseDelete()

Permanently deletes the current database file from the hard disk where it is stored.

Throws:

No plans to implement

Type
Error

(inner) fileDatabaseInfo()

Displays the Properties box for the current database.

Throws:

No plans to implement

Type
Error

(inner) fileDatabaseRemove()

Removes the current database icon from the workspace.

Throws:

No plans to implement

Type
Error

(inner) fileDatabaseUseServer()

Displays the Switch Servers dialog box, where the user can choose a server that contains a replica of the currently selected database.

Throws:

No plans to implement

Type
Error

(inner) fileExit()

Performs the menu command File - Exit (File - Quit on the Macintosh), which closes Notes/Domino and all its open windows.

Throws:

No plans to implement

Type
Error

(inner) fileExport()

Exports a Notes/Domino document or view.

Throws:

No plans to implement

Type
Error

(inner) fileFullTextCreate()

Displays the Full-Text Create Index dialog box, where the user can specify settings for the database's full-text index.

Throws:

No plans to implement

Type
Error

(inner) fileFullTextDelete()

Deletes a database's full-text index.

Throws:

No plans to implement

Type
Error

(inner) fileFullTextInfo()

Displays the Full Text tab of the current database's Properties box.

Throws:

No plans to implement

Type
Error

(inner) fileFullTextUpdate()

Updates full-text indexes for local databases or queues the update request for server-based databases.

Throws:

No plans to implement

Type
Error

(inner) fileImport()

Imports a file into a Notes/Domino document or view.

Throws:

No plans to implement

Type
Error

(inner) fileNewDatabase()

Displays the New Database dialog box, where the user can select a server, title, and file name for a new database.

Throws:

No plans to implement

Type
Error

(inner) fileNewReplica()

Displays the New Replica dialog box, where the user can create a replica of the current database.

Throws:

No plans to implement

Type
Error

(inner) fileOpenDatabase(serverDatabase, viewName, key) → {Promise.<boolean>}

Opens the specified database to the specified view, highlighting the first document whose value in the sort column matches the key. You specify a database using its server and file name.

Parameters:
NameTypeDescription
serverDatabase*
viewNamestring
key*
See
Returns:
Type: 
Promise.<boolean>

(inner) fileOpenDBRepID()

Opens the specified database to the specified view, highlighting the first document whose value in the sort column matches the key. You specify a database using its replica ID, and Notes/Domino searches the workspace and all servers available in the current session to find a replica.

Throws:

No plans to implement

Type
Error

(inner) filePageSetup()

Displays the Page Setup dialog box (or, on the Macintosh, the File Print Margins dialog box), which allows you to specify print settings for the selected database.

Throws:

No plans to implement

Type
Error

(inner) filePrint(numCopies, fromPage, toPage, ifDraft, ifView, formName, breakType, ifReset, startDate, endDate) → {void}

Prints the currently open or selected document(s), or the current view.

Parameters:
NameTypeDescription
numCopiesstring

The number of copies you want to print. Specify an empty string ("") for one copy.

fromPagestring

The page of a document where you want to start printing. Specify an empty string ("") if you want to print all pages.

toPagestring

The page of a document where you want to stop printing. Specify an empty string ("") if you want to print all pages.

ifDraftstring

Either the word "draft", to indicate that you want draft quality printing; or an empty string ("") if you want regular quality printing.

ifViewstring

Either the word "printview", to indicate that you want to print the current view; or an empty string ("") if you want to print the selected document(s) in a view, not the view itself.

formNamestring

The name of the form you want to use to print the document. Specify an empty string ("") if you want to print the document using its current form.

breakTypestring

Either the word "pagebreak", the word "line", or an empty string ("").

ifResetstring

Either the word "resetpages", or an empty string ("").

startDateany

Time-date. Optional. Used with the printview parameter when printing a calendar view; indicates the first date to be printed.

endDateany

Time-date. Optional. Used with the printview parameter when printing a calendar view; indicates the last date to be printed.

See
Returns:
Type: 
void

(inner) filePrintSetup()

Displays the Print Setup dialog box, which allows you to direct the current view or document to a printer or a file that you specify.

Throws:

No plans to implement

Type
Error

(inner) fileSave() → {Promise.<boolean>}

Performs the menu command File - Save.

See
Returns:
Type: 
Promise.<boolean>

(inner) fileSaveNewVersion()

Saves a document as a new version.

Throws:

No plans to implement

Type
Error