ApiRun
Class representing a small text block called 'run'.
ApiRun is a subclass of ApiTextPr.
Methods
The following table lists the available methods.
| Method | Returns | Description |
|---|---|---|
| AddColumnBreak | boolean | Adds a column break to the current run position and starts the next element from a new column. |
| AddComment | ApiComment | null | undefined | Adds a comment to the current run. |
| AddDrawing | boolean | Adds a drawing object (image, shape or chart) to the current text run. |
| AddHyperlink | ApiHyperlink | null | undefined | Adds a hyperlink to the current run. |
| AddLineBreak | boolean | Adds a line break to the current run position and starts the next element from a new line. |
| AddPageBreak | boolean | Adds a page break and starts the next element from a new page. |
| AddTabStop | boolean | Adds a tab stop to the current run. |
| AddText | boolean | Adds some text to the current run. |
| ClearContent | boolean | Clears the content from the current run. |
| Copy | ApiRun | Creates a copy of the current run. |
| Delete | boolean | Deletes the current run. |
| GetBold | boolean | null | undefined | Gets the bold property from the current text properties. |
| GetCaps | boolean | null | undefined | Returns whether the text with the current text properties are capitalized. |
| GetClassType | "run" | Returns a type of the ApiRun class. |
| GetColor | ApiColor | null | undefined | Gets the RGB color from the current text properties. |
| GetDoubleStrikeout | boolean | null | undefined | Gets the double strikeout property from the current text properties. |
| GetFontFamily | string | null | undefined | Returns the font family from the current text properties. |
| GetFontNames | string[] | Returns all font names from all elements inside the current run. |
| GetFontSize | hps | null | undefined | Gets the font size from the current text properties. |
| GetHighlight | string | null | undefined | Gets the highlight property from the current text properties. |
| GetItalic | boolean | null | undefined | Gets the italic property from the current text properties. |
| GetLanguage | string | null | undefined | Gets the language from the current text properties. |
| GetOutLine | ApiStroke | Gets the text outline from the current text properties. |
| GetParent | ParagraphLikeContainer | null | undefined | Returns the parent element (a paragraph or an inline content control) that directly contains the current run. |
| GetParentContentControl | ApiBlockLvlSdt | ApiInlineLvlSdt | null | Returns a content control that contains the current run. |
| GetParentParagraph | ApiParagraph | null | undefined | Returns a parent paragraph of the current run. |
| GetParentTable | ApiTable | null | Returns a table that contains the current run. |
| GetParentTableCell | ApiTableCell | null | Returns a table cell that contains the current run. |
| GetPosInParent | Number | Returns the position (index) of the current run within its parent element. |
| GetPosition | hps | null | undefined | Gets the text position from the current text properties measured in half-points (1/144 of an inch). |
| GetRange | ApiRange | Returns a Range object that represents the part of the document contained in the specified run. |
| GetShd | ApiShd | undefined | Gets the text shading from the current text properties. |
| GetSmallCaps | boolean | null | undefined | Returns whether the text with the current text properties are displayed capitalized two points smaller than the actual font size. |
| GetSpacing | twips | null | undefined | Gets the text spacing from the current text properties measured in twentieths of a point. |
| GetStrikeout | boolean | null | undefined | Gets the strikeout property from the current text properties. |
| GetStyle | ApiStyle | null | undefined | Gets the style of the current text properties. |
| GetText | string | Returns a text from the text run. |
| GetTextFill | ApiFill | Gets the text fill from the current text properties. |
| GetTextPr | ApiTextPr | Returns the text properties of the current run. |
| GetUnderline | boolean | null | undefined | Gets the underline property from the current text properties. |
| GetVertAlign | string | null | undefined | Gets the vertical alignment type from the current text properties. |
| MoveCursorToPos | boolean | Moves a cursor to a specified position of the current text run. |
| RemoveAllElements | boolean | Removes all the elements from the current run. |
| Select | boolean | Selects the current run. |
| SetBold | ApiTextPr | Sets the bold property to the text character. |
| SetCaps | ApiTextPr | Specifies that any lowercase characters in the text run are formatted for display only as their capital letter character equivalents. |
| SetColor | ApiTextPr | Sets the text color to the current text run. |
| SetDoubleStrikeout | ApiTextPr | Specifies that the contents of the run are displayed with two horizontal lines through each character displayed on the line. |
| SetFontFamily | ApiTextPr | Sets all 4 font slots with the specified font family. |
| SetFontSize | ApiTextPr | Sets the font size to the characters of the current text run. |
| SetHighlight | ApiTextPr | Specifies a highlighting color which is added to the text properties and applied as a background to the contents of the current run/range/paragraph. |
| SetItalic | ApiTextPr | Sets the italic property to the text character. |
| SetLanguage | ApiTextPr | Specifies the languages which will be used to check spelling and grammar (if requested) when processing the contents of the text run. |
| SetOutLine | ApiTextPr | Sets the text outline to the current text run. |
| SetPosition | ApiTextPr | Specifies an amount by which text is raised or lowered for this run in relation to the default baseline of the surrounding non-positioned text. |
| SetShd | ApiTextPr | Specifies the shading applied to the contents of the current text run. |
| SetSmallCaps | ApiTextPr | Specifies that all the small letter characters in the text run are formatted for display only as their capital letter character equivalents which are two points smaller than the actual font size specified for this text. |
| SetSpacing | ApiTextPr | Sets the text spacing measured in twentieths of a point. |
| SetStrikeout | ApiTextPr | Specifies that the contents of the run are displayed with a single horizontal line through the center of the line. |
| SetStyle | ApiTextPr | The text style base method. |
| SetText | ApiRun | Replaces the whole text of the current run with the specified text, keeping the run properties. |
| SetTextFill | ApiTextPr | Sets the text fill to the current text run. |
| SetTextPr | ApiTextPr | Sets the text properties to the current run. |
| SetUnderline | ApiTextPr | Specifies 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). |
| SetVertAlign | ApiTextPr | Specifies the alignment which will be applied to the contents of the run in relation to the default appearance of the run text: |
| ToJSON | JSON | Converts the ApiRun object into the JSON object. |
| WrapInMailMergeField | boolean | Wraps a run in a mail merge field. |