Comment Element

Visio XML Reference

Contains the comment text in string format for a shape.

Syntax

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

Attributes

Unit

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

F

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.

V

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 Comment 
Minimum Occurrences
Maximum Occurrences

Element information

Parent elements

Misc

Annotation

Child elements

None

Remarks

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

The Comment element in an Annotation element is relevant only when contained in a PageSheet element. It is ignored when contained in a DocumentSheet, Shape, or StyleSheet element.

Example

The following example shows how the Comment element is used when it is contained in an Annotation element. In this example, there is no text in the comment, and therefore the V attribute is set to "null".

XML
  <Annotation IX="0">
    <X>0</X>
    <Y>11.69291338582677</Y>
    <ReviewerID>1</ReviewerID>
    <MarkerIndex>1</MarkerIndex>
    <Date F="DATETIME(37882.570069444)">2003-09-18T13:40:54</Date>
    <Comment V="null" />
    <LangID></LangID>
</Annotation> 

See also

Comment cell (Miscellaneous section)

Comment cell (Annotation section)