RichHtmlText

Inserts text formatted using html into the document. The html doesn’t need to be a full document, but paragraphs does need to be tagged. The string This is a text with <b>bold</b> text. Is not a valid format, but <p>This is a text with <b>bold</b> text.</p> is valid.

Syntax

{ "BindingType": "RichHtmlText", "BindingKey": "RichTextPath" }

Parameters

BindingType: Static. Must be “RichHtmlText”.
BindingKey: string, The html string to insert. See below for valid html elements.

Supported HTML tags

• <b>
• <br/>
• <font face=”” size=”” color=””>
  • Face
    Optional attribute, name of the font family
  • Size
    Optional attribute, size of the font, integer from 1 to 7, 3 being the normal size
  • Color
    Optional attribute, the color of the text. Can be a name, ex: ‘Red’, hex value, or RGB format, ex ‘rgb(255,0,0)’.
• <h1>
• <h2>
• <h3>
• <h4>
• <h5>
• <h6>
• <i>
• <li>
• <ol start=””>
  • Start
    Optional attribute, the value of the first list item in the list
• <p>
• <sub>
• <sup>
• <u>

User Style

It is possible to overwrite how tags change the style of a paragraph and introduce new inline tags. Inline tags are tags used within a paragraph, such as <b>. All style properties that can be set is listed below in the Style Properties section. The following user style makes the bold tag also add underscore.

{ “b”: 
  { “underscore”: true }
}

The type <Integer, String> is a dictionary with Integer as key and String as value. It is used when mapping the level of a list to a specific style or string/symbol. The level of a list starts at 0, with no indent. The following user style sets the style of numbered list to use Arabic numbers at no indent, Roman numbers at one indent and alphabetic letters at two indents.

{ “ol”: 
  { “bulletStyle”: 
    { 
      “0”: “1.”, 
      “1”: ”i.”,
      “2”: “a.” 
    } 
  }
}

Style Properties

The following properties can be used to override HTML styling.

• Alignment
  • L
    Left
  • Ctr
    Center
  • R
    Right
• BackgroundColor, string
  The color behind the text, same format as TextColor
• BaseLine, number
  Moves text down if negative, and up if positive. Default for Subscript and Superscript is -25000 and 30000 respectively.
• Bold, boolean
  Makes text bold if true
• BulletChar, <integer, string>
  A mapping of numbered list level, and what string to use as the bullet
• BulletStyle, <integer, string>
  A mapping of numbered list level and what style to use for bullets. The following types of bullets are supported:
  • l.
  • l)
  • i.
  • i)
  • I.
  • I)
  • a.
  • a)
  • A.
  • A)
• DefaultFontSize, decimal number
  The size of the text at a factor of 1. Usually only set int he body, and then factor is used in the remaining tags, but it is not a requirement.
• Font, text
  Name of the font to use. Write it as displayed in Powerpoint.
• FontSizeFactor, decimal number
  The size of teh text in a tag is by default some % of the default font size. A factor of 1 means that size is unchanged.
• Indent, number
  Adds a margin to the left side of the first line of a paragraph.
• IsNumbered, boolean
  Marks paragraph as a numbered list item.
• Italic, boolean
  Makes text italic if true
• LineSpace, decimal number
  Multiplier of line space in a paragraph. So 2 is 200% and 1.5 is 150%
• MarginLeft, number
  Adds a margin to the left side of the entire paragraph.
• NumberStart, number
  The number of the first list item in a numbered list.
• ShowBullet, boolean
  Markrs paragraph as a bullet list item.
• SpaceAfter, decimal number
  Points of empty space to add after a paragraph.
• SpaceBefore, decimal number
  Points of empty space to add before a paragraph.
• TextColor, text
  The color of the text. Can either use a name ‘red’, Hex value ‘#ff0000’, or rgb format ‘rgb(255,0,0)’.
• Underscore, boolean
  Adds a single line of underscore to the text if true.