Marks the currently selected document for deletion.

Note This @command is new with Release 5.

Syntax

@Command( [MoveToTrash] )

Usage

The View applet is programmable via this @Command.

@Command([MoveToTrash]) is identical to @Command([EditClear]) except, on the Web @Command([EditClear]) causes the current document to be deleted. @Command([MoveToTrash]) provides consistent behavior for the Notes Client and Web users.

This command does not permanently delete documents; it marks them for deletion. To permanently delete the documents marked for deletion, the user must refresh the view manually, or programmatically using any function that refreshes the view, such as the ViewRefreshFields @command. A user can also permanently delete documents marked for deletion by triggering the EmptyTrash @command.

MoveToTrash has the same functionality as selecting a document in a view and pressing the Delete key. You can toggle both. Just as you can remove the deletion mark from a selected document in a view by pressing the Delete key a second time, if you trigger the MoveToTrash command a second time, the mark for deletion is removed from the document.

Language cross-reference

DeleteDocument method of LotusScript NotesDocumentCollection class

deleteDocument method of Java DocumentCollection class

Example
See Also

@Commands

Glossary