Prompt Element [Visio 2003 SDK Documentation]

Article
05/01/2007

Contains varying prompt information, based on the element in which it is contained.

When contained in a Prop element, the Prompt element specifies descriptive or instructional text that appears to users in the Custom Properties dialog box when the property is selected. This text also appears as a tool tip when the mouse pointer is paused over the property in the Custom Properties window.

When contained in a User element, specifies a descriptive prompt or comment for the user-defined element.

When contained in a Connection element, this element is reserved for future use.

When contained in a Control element, the Prompt element specifies descriptive text that appears as a tool tip when the mouse pointer is paused over a shape's control handle.

Syntax

<Prompt>
    [Unit]
    [F]
    [Err]
    [V]>
</Prompt>

Attributes

Unit

Optional string. Represents a unit of measure. The default is STR. For details about STR, 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.

Optional string. Represents the null string condition for a string cell value. In some cases it is helpful to distinguish between an empty string cell null and a null string cell value. This attribute is used to distinguish between these forms of an empty value.

Element properties

Property	Value
Name	Prompt
Minimum Occurrences	0
Maximum Occurrences	1

Element information

Parent elements

Child elements

None

Remarks

A Prompt element contained in a Connection or Control element is relevant only when contained in a Shape element. It is ignored when contained in a DocumentSheet, PageSheet or StyleSheet element.

A Prompt element contained in a Prop or User element is relevant only when contained in a DocumentSheet, PageSheet, or Shape element. It is ignored when contained in a StyleSheet element.

Share via