Permanently deletes a document from a database, but does a soft deletion if soft deletions are enabled.

Defined in

NotesDocument

Syntax

flag = notesDocument.Remove( force )

Parameters

force

Boolean. If True, the document is deleted even if another user modifies the document after the script opens it. If False, the document is not deleted if another user modifies it.

• True indicates that the document was successfully deleted.
• False indicates that the document was not deleted, because another user modified it and the force parameter is set to False.

This method does a soft deletion if "Allow soft deletions" is enabled. See RemovePermanently to do a hard deletion.

If you access a NotesDocument object through the Document property of NotesUIDocument, you can't delete the back-end document. If you could, the UI rendition would have no basis. You must access the document strictly through the back-end.

A deleted document cannot be used as a basis for navigation in a view or a document collection.

You cannot use the remove method on a Document object returned by the DocumentContext property.

Language cross-reference

remove method in Java Document class

@DeleteDocument function in formula language

Example
See Also

Removing a document in LotusScript classes

Glossary