Represents an action. An action is code that consists of one or a combination of Domino actions, formula language @functions or @commands, LotusScript language or Java language programs. The developer indicates how an action can be accessed by a user; it is usually displayed as a button in an action bar in a view, form, or page, or is included in the Actions option on the menu bar.

Containment Hierarchy

Contained by: <actionbar>, <sharedactions>

Contains: <code>, <imageref>

Syntax

<!ELEMENT action ( imageref?, code* )>

Content

imageref? , code*

Contains an optional <imageref> element (if the action uses a shared image for the action button graphic) followed by any number of <code> elements.

<!ATTLIST action

title	%tstring;	#IMPLIED
id	%integer;	#IMPLIED
displaytype	(%action.types;)	"button"
targetframe	%string;	#IMPLIED
hide	%tokens;	""
showinmenu	%boolean;	"true"
showinbar	%boolean;	"true"
systemcommand	(%action.systemcommands;)	#IMPLIED
icon	%integer;	#IMPLIED
graphicalalign	(%lr.aligns;)	"left"
align	(%lr.aligns;)	"left"
onlyiconinbar	%boolean;	"false"
%reading.order.attrs;
%notesflow.publishing.attrs;

>

align

Alignment of the action bar in the window. See the %lr.aligns; entity for a list of options.

Defines how to display the action. The options are defined in the %action.types; entity. Default is button.

Alignment of the icon in relation to the text on the action button. See the %lr.aligns; entity for a list of options.

Keyword option indicating when to hide the action, as defined in the %action.hide.tokens; entity.

The integer value representing the Notes icon in the table of column icons. See the Table of column icons in the Application Development with Domino Designer book.

The ID of a shared action. Since all shared actions in a database are represented by a single form note, each action is differentiated from the others with a unique id.

If true, the action icon displays, without text, in the action bar. Default is false.

If true (the default), displays the action in the action bar.

If true (the default), displays the action by name in the Actions menu.

Built-in Notes actions as defined in the %action.systemcommands; entity.

Specifies the name of the frame in which to display the result of the action.

Name assigned to the action.

The %action.hide.tokens; entity lists the keyword tokens for hiding the actions.

Syntax:

<!ENTITY % action.hide.tokens "read | edit | preview | previewedit | notes | web | mobile ">

The following keyword tokens hide the action, by not displaying it in the action bar or Action menu under the following conditions:

edit

When a document is opened for editing.

When accessed by a mobile user.

When accessed by a Notes Release 4.6 or later client.

When a document is previewed for reading.

When a document is previewed for editing.

When a document is opened for reading.

When accessed by a Web browser.

actions. These actions enable the user to perform common Notes tasks; they always display in the Actions menu. The action choice is either enabled or disabled depending on what area of the UI is displayed in the main window. For example, if a document has focus, the Edit Document action (edit option below) displays as enabled in the Actions menu.

Syntax:

<!ENTITY % action.systemcommands "categorize | edit | send | forward | movetofolder | removefromfolder ">

The %action.types; entity defines the display options for actions. The default is button.

Syntax:

<!ENTITY % action.types "button | checkbox | menuseparator ">

The %notesflow.publishing.attrs; entity defines whether and how to publish an action so that is can be accessed from the Action menu on any open OLE server application.

Syntax:

<!ENTITY % notesflow.publishing.attrs "

publishonolelaunch	%boolean;	"false"
closewhenchosen	%boolean;	#IMPLIED
docfocuswhenchosen	%boolean;	#IMPLIED

">

closewhenchosen

If true, indicates that the OLE object should close and focus should return to Notes when the action is chosen.

If true, indicates that the document window should be given focus when the action is chosen.

If true, indicates that the action should be published with the OLE object.

The Domino DTD

Glossary