Skip to main content

ApiRichTextPr

Class representing the rich text properties.

Methods​

The following table lists the available methods.

MethodReturnsDescription
GetBoldboolean | null | undefinedGets the bold property from the current text properties.
GetClassType"richTextPr"Returns a type of the ApiRichTextPr class.
GetColorApiColor | null | undefinedGets the RGB color from the current text properties.
GetFontFamilystring | null | undefinedReturns the font family from the current text properties.
GetFontSizehps | null | undefinedGets the font size from the current text properties.
GetItalicboolean | null | undefinedGets the italic property from the current text properties.
GetStrikeoutboolean | null | undefinedGets the strikeout property from the current text properties.
GetUnderlineboolean | null | undefinedGets the underline property from the current text properties.
GetVertAlignTextVertAlignGets the vertical alignment type from the current text properties.
SetBoldApiRichTextPrSets the bold property to the text character.
SetColorApiRichTextPrSets the text color to the current text run.
SetFontFamilyApiRichTextPrSets all 4 font slots with the specified font family.
SetFontSizeApiRichTextPrSets the font size to the characters of the current text run.
SetItalicApiRichTextPrSets the italic property to the text character.
SetStrikeoutApiRichTextPrSpecifies that the contents of the run are displayed with a single horizontal line through the center of the line.
SetUnderlineApiRichTextPrSpecifies that the contents of the run are displayed along with a line appearing directly below the character (less than all the spacing above and below the characters on the line).
SetVertAlignApiRichTextPrSpecifies the alignment which will be applied to the contents of the run in relation to the default appearance of the run text: