Action Element [Visio 2003 SDK Documentation]

Article
05/01/2007

Contains the formula to execute when a user clicks the command name defined in the corresponding Menu element.

Syntax

<Action>
    [Unit]
    [F]
    [Err]>
</Action>

Attributes

Unit

Optional string. Represents a unit of measure. The default is NUM. For details about NUM, see Units of measure.

Optional string. Represents the element's formula. This attribute can contain one of the following strings: "someFormula" if the formula exists locally, "No Formula" if the formula is locally deleted or blocked, or "Inh" if the formula is inherited.

If the attribute is not present, the element's formula is a simple constant, for example, <element>5</element>.

Err

Optional string. Indicates that the formula evaluates to an error. The value of Err is the current value (an error message string); the value of the element is the last valid value.

Element properties

Property	Value
Name	Action
Minimum Occurrences	0
Maximum Occurrences	1

Element information

Parent elements

Act

Child elements

None

Remarks

Remarks

The formula in an Action element is evaluated only when the action occurs, not when the formula is entered into the element.

The Action element is relevant only when contained in a Shape or PageSheet element. It is ignored when contained in a DocumentSheet or StyleSheet element.

Example

In the following example, the F attribute in the Action element contains the action to execute when the Lock Text command is clicked on the shortcut menu.

<Act IX="0">
  <Menu>Lock Text</Menu> 
  <Action F="SetF(GetRef(LockTextEdit),TRUE)">0</Action> 
  <Checked>0</Checked> 
  <Disabled>0</Disabled> 
</Act>