ApiParaPr
Class representing the paragraph properties.
Methods
The following table lists the available methods.
| Method | Returns | Description |
|---|---|---|
| GetBetweenBorder | Border | undefined | Returns the between border of the current paragraph. |
| GetBottomBorder | Border | undefined | Returns the bottom border of the current paragraph. |
| GetClassType | "paraPr" | Returns a type of the ApiParaPr class. |
| GetContextualSpacing | boolean | undefined | Returns the contextual spacing value of the current paragraph. |
| 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. |
| GetKeepLines | boolean | undefined | Returns the keep lines value of the current paragraph. |
| GetKeepNext | boolean | undefined | Returns the keep next value of the current paragraph. |
| GetLeftBorder | Border | undefined | Returns the left border of the current paragraph. |
| GetNumPr | ApiNumberingLevel | undefined | Returns the numbering level for the current paragraph referencing the numbering definition instance in the current document. |
| GetOutlineLvl | Number | undefined | Returns the outline level of the specified properties. |
| GetPageBreakBefore | boolean | undefined | Returns the page break before value of the current paragraph. |
| GetRightBorder | Border | undefined | Returns the right border of the current paragraph. |
| GetShd | Shd | undefined | 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. |
| GetTabs | TabStop[] | Returns the custom tab stops of the current paragraph. |
| GetTopBorder | Border | undefined | Returns the top border of the current paragraph. |
| GetWidowControl | boolean | undefined | Returns the widow control value of the current paragraph. |
| 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. |
| 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. |
| SetSpacingBefore | boolean | Sets the spacing before the current paragraph. |
| SetSpacingLine | boolean | Sets the paragraph line spacing. |
| SetStyle | boolean | The paragraph style base method. |
| SetTabs | boolean | Specifies a sequence of custom tab stops which will be used for any tab characters in the current paragraph. |
| SetTopBorder | boolean | Specifies the border which will be displayed above a set of paragraphs which have the same set of paragraph border settings. |
| 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. |