Skip to main content

ApiRichRun

Class representing a small text block called 'run'.

ApiRichRun is a subclass of ApiRichTextPr.

Methods​

The following table lists the available methods.

MethodReturnsDescription
AddTextbooleanAdds some text to the current run.
ClearContentbooleanClears the content from the current run.
CopyApiRichRunCreates a copy of the current run.
DeletebooleanDeletes the current run.
GetBoldboolean | null | undefinedGets the bold property from the current text properties.
GetClassType"richRun"Returns a type of the ApiRichRun 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.
GetParentParagraphApiRichParagraph | null | undefinedReturns a parent paragraph of the current run.
GetStrikeoutboolean | null | undefinedGets the strikeout property from the current text properties.
GetTextstringReturns a text from the text run.
GetTextPrApiRichTextPrReturns the text properties of the current run.
GetUnderlineboolean | null | undefinedGets the underline property from the current text properties.
GetVertAlignTextVertAlignGets the vertical alignment type from the current text properties.
RemoveAllElementsbooleanRemoves all the elements from the current run.
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.
SetTextPrApiRichTextPrSets the text properties to the current run.
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: