Clear @Command (Formula Language)

Performs the menu command Edit - Delete.

Note: This command is new with Release 6.

Syntax

@Command( [Clear] )

Usage

This command executes immediately. Use the EditClear @command to execute after all @functions. See the Order of evaluation for formula statements topic for more details.

In a view, folder, or a document in Read mode in a Notes® application, marks the currently selected document for deletion. If you include functions that access or assign values to fields or properties in that document after this @command in a formula, they are ignored.

In a document in Edit mode, deletes the highlighted data (text, tables, graphics, links, file attachments, or objects).

In Web applications, only use this command on a form to delete the entire current document. It cannot be used to delete highlighted data on a form in Edit mode; if executed on a form, it deletes the entire document. You cannot use this command to mark selected documents in a view for deletion. Use the MoveToTrash @Command instead. To customize the "Deleted" confirmation page returned by the server, create a form named "$$ReturnDocumentDeleted." See Customizing "Form processed" confirmation for the Web in the Application Development with Domino® Designer guide for details.

In Notes® applications, when this command is called on a form, subform, view, or folder in Design mode, it deletes the highlighted data, fields, or columns.

On the workspace, removes the selected icon (without permanently deleting the database from disk).

It is most convenient to use toolbar buttons to invoke this command.

Examples

The following code, when included in a form Delete action, deletes the current document and returns to the Locations view:
@Command([Clear]);
@Command([OpenView];"Locations")