TheText Element [Visio 2003 SDK Documentation]

Article
05/01/2007

An event element that is evaluated when a shape's text or text composition changes.

Syntax

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

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	TheText
Minimum Occurrences	0
Maximum Occurrences	1

Element information

Parent elements

Event

Child elements

None

Remarks

Event elements are evaluated only when the event occurs, not upon formula entry. The TheText element can be used to trigger recalculations, for example, to recalculate the text width and height with the TEXTWIDTH( ) and TEXTHEIGHT( ) functions.

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

Share via