TextBkgnd Element [Visio 2003 SDK Documentation]

Article
05/01/2007

Specifies the text background color for a shape.

Syntax

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

Attributes

Unit

Optional string. Represents a unit of measure. The default is COLOR. For details about COLOR, 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	TextBkgnd
Minimum Occurrences	0
Maximum Occurrences	1

Element information

Parent elements

TextBlock

Child elements

None

Remarks

To set the color, enter a number from 0 to 24 or the RGB value in hexadecimal notation. To select a color value, add 1 to the value listed in the document color table, which is contained in the Colors element.

You can also specify a custom color by using its RGB (red, blue, green) value plus one, or by specifying a formula. Enter a custom color in the following format: #rrggbb, where rr, gg, and bb are in hexadecimal notation.

If a formula can be reconstructed from the RGB value, the formula is not saved. For example, because the formula RGB(255, 153, 0) represented in hexadecimal notation is #ff9900, the value #ff9900 would be saved in the DatadiagramML file.

You can set the transparency of the text background color in the TextBkgndTrans element.

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

Example

<TextBkgnd F='RGB(0,0,77)+1'>#00004d</TextBkgnd>