Description Element [Visio 2003 SDK Documentation]

Article
05/01/2007

When it is contained in a Hyperlink element, the Description element contains a text string that describes the hyperlink.

When it is contained in a SmartTagDef element, the Description element contains a string that describes the smart tag, which appears as a tool tip when the user pauses the mouse over the tag.

Syntax

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

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

Element information

Parent elements

Hyperlink

SmartTagDef

Child elements

None

Remarks

Use this element to store comments about the hyperlink or smart tag; for example, "Link to our pricing Web site." This text is also displayed on the shape's right-click menu, and when the user's mouse pauses over the shape or smart tag.

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

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

Example

In the following example, the Description element contains the description of a hyperlink to the Microsoft Office Developer Center on MSDN.

<Hyperlink ID="1">
  <Description>The Microsoft Office Developer Center</Description> 
  <Address>http://msdn.microsoft.com/office/</Address> 
  <SubAddress>0</SubAddress> 
  <ExtraInfo>0</ExtraInfo> 
  <Frame F="No Formula" /> 
  <NewWindow>0</NewWindow> 
  <Default>0</Default> 
</Hyperlink>

Share via