LegendItem API

A LegendItem is an element of a Legend and consists of a color field and a text.

• imageSource

  defines the path to the image source.

  See: Specifying the Image Source

• semantics

  Specifies the color of the LegendItem. The semantics property is represented by enumeration type WDTableCellDesign.

  The enumeration values are described in: WDTableCellDesign

• striped

  Specifies whether the icon will be rendered striped. A specified value of imageSource property will be ignored.

• text

  Determines the text of the LegendItem.

• textDirection

  Specifies the text direction and allows you to use a LegendItem for texts in languages which require a specific text direction. The textDirectionproperty can be filled with the following values and is represented by the enumeration type WDTextDirection.

  inherit	The text direction is inherited from the parent element. Therefore, the text direction is identical to the one of the parent element.
  ltr	The text runs from left to right.
  rtl	The text runs from right to left.

  The default value for this property is inherit.

• tooltip

  This property describes a note for the LegendItem that is displayed when the user places the cursor on the LegendItem.

• visible

  Determines whether the LegendItem is visible.

 

Common UI Element Properties