ApiParaPr
Represents the ApiParaPr class.
Methods
| Method | Returns | Description |
|---|---|---|
| GetClassType | "paraPr" | Returns a type of the ApiParaPr class. |
| GetIndFirstLine | twips | undefined | Returns the paragraph first line indentation. |
| GetIndLeft | twips | undefined | Returns the paragraph left side indentation. |
| GetIndRight | twips | undefined | Returns the paragraph right side indentation. |
| GetJc | "left" | "right" | "both" | "center" | undefined | Returns the paragraph contents justification. |
| GetOutlineLvl | Number | Returns the outline level of the specified properties. |
| GetShd | ApiRGBColor | Returns the shading applied to the contents of the paragraph. |
| GetSpacingAfter | twips | Returns the spacing after value of the current paragraph. |
| GetSpacingBefore | twips | Returns the spacing before value of the current paragraph. |
| GetSpacingLineRule | "auto" | "atLeast" | "exact" | undefined | Returns the paragraph line spacing rule. |
| GetSpacingLineValue | twips | line240 | undefined | Returns the paragraph line spacing value. |
| GetStyle | ApiStyle | Returns the paragraph style method. |
| SetBetweenBorder | boolean | Specifies the border which will be displayed between each paragraph in a set of paragraphs which have the same set of paragraph border settings. |
| SetBottomBorder | boolean | Specifies the border which will be displayed below a set of paragraphs which have the same paragraph border settings. 💡 The paragraphs of the same style going one by one are considered as a single block, so the border is added to the whole block rather than to every paragraph in this block. |
| SetContextualSpacing | boolean | Specifies that any space before or after this paragraph set using the ApiParaPr#SetSpacingBefore or ApiParaPr#SetSpacingAfter spacing element, should not be applied when the preceding and following paragraphs are of the same paragraph style, affecting the top and bottom spacing respectively. |
| SetIndFirstLine | boolean | Sets the paragraph first line indentation. |
| SetIndLeft | boolean | Sets the paragraph left side indentation. |
| SetIndRight | boolean | Sets the paragraph right side indentation. |
| SetJc | boolean | Sets the paragraph contents justification. |
| SetKeepLines | boolean | Specifies that when rendering the document using a page view, all lines of the current paragraph are maintained on a single page whenever possible. |
| SetKeepNext | boolean | Specifies that when rendering the document using a paginated view, the contents of the current paragraph are at least partly rendered on the same page as the following paragraph whenever possible. |
| SetLeftBorder | boolean | Specifies the border which will be displayed at the left side of the page around the specified paragraph. |
| SetNumPr | boolean | Specifies that the current paragraph references a numbering definition instance in the current document. |
| SetOutlineLvl | boolean | Sets the outline level for the specified properties. |
| SetPageBreakBefore | boolean | Specifies that when rendering the document using a paginated view, the contents of the current paragraph are rendered at the beginning of a new page in the document. |
| SetRightBorder | boolean | Specifies the border which will be displayed at the right side of the page around the specified paragraph. |
| SetShd | boolean | Specifies the shading applied to the contents of the paragraph. |
| SetSpacingAfter | boolean | Sets the spacing after the current paragraph. If the value of the isAfterAuto parameter is true, then any value of the nAfter is ignored. If isAfterAuto parameter is not specified, then it will be interpreted as false. |
| SetSpacingBefore | boolean | Sets the spacing before the current paragraph. If the value of the isBeforeAuto parameter is true, then any value of the nBefore is ignored. If isBeforeAuto parameter is not specified, then it will be interpreted as false. |
| SetSpacingLine | boolean | Sets the paragraph line spacing. If the value of the sLineRule parameter is either "atLeast" or "exact", then the value of nLine will be interpreted as twentieths of a point. If the value of the sLineRule parameter is "auto", then the value of the nLine parameter will be interpreted as 240ths of a line. |
| SetStyle | boolean | The paragraph style base method. 💡 This method is not used by itself, as it only forms the basis for the ApiParagraph#SetStyle method which sets the selected or created style for the paragraph. |
| SetTabs | boolean | Specifies a sequence of custom tab stops which will be used for any tab characters in the current paragraph. -Warning: The lengths of aPos array and aVal array -MUST BE equal to each other. |
| SetTopBorder | boolean | Specifies the border which will be displayed above a set of paragraphs which have the same set of paragraph border settings. 💡 The paragraphs of the same style going one by one are considered as a single block, so the border is added to the whole block rather than to every paragraph in this block. |
| SetWidowControl | boolean | Specifies whether a single line of the current paragraph will be displayed on a separate page from the remaining content at display time by moving the line onto the following page. |
| ToJSON | JSON | Converts the ApiParaPr object into the JSON object. |