Get Started
Usage API
More information

ApiParaPr

new ApiParaPr()

Class representing the paragraph properties.

Methods

Name Description
GetClassType

Returns a type of the ApiParaPr class.

GetIndFirstLine

Returns the paragraph first line indentation.

GetIndLeft

Returns the paragraph left side indentation.

GetIndRight

Returns the paragraph right side indentation.

GetJc

Returns the paragraph contents justification.

GetShd

Returns the shading applied to the contents of the paragraph.

GetSpacingAfter

Returns the spacing after value of the current paragraph.

GetSpacingBefore

Returns the spacing before value of the current paragraph.

GetSpacingLineRule

Returns the paragraph line spacing rule.

GetSpacingLineValue

Returns the paragraph line spacing value.

GetStyle

Returns the paragraph style method.

SetBetweenBorder

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

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.

SetBullet

Sets the bullet or numbering to the current paragraph.

SetContextualSpacing

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

Sets the paragraph first line indentation.

SetIndLeft

Sets the paragraph left side indentation.

SetIndRight

Sets the paragraph right side indentation.

SetJc

Sets the paragraph contents justification.

SetKeepLines

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

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

Specifies the border which will be displayed at the left side of the page around the specified paragraph.

SetNumPr

Specifies that the current paragraph references a numbering definition instance in the current document.

SetPageBreakBefore

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

Specifies the border which will be displayed at the right side of the page around the specified paragraph.

SetShd

Specifies the shading applied to the contents of the paragraph.

SetSpacingAfter

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

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

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

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

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

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

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

Converts the ApiParaPr object into the JSON object.

Example

Copy code
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oHeading6Style = oDocument.GetStyle("Heading 6");
var oParaPr = oHeading6Style.GetParaPr();
oParaPr.SetStyle(oHeading6Style);
oParaPr.SetJc("center");
var oParagraph = oDocument.GetElement(0);
oParagraph.SetStyle(oHeading6Style);
oParagraph.AddText("This is a text in a paragraph styled with the 'Heading 6' style.");
builder.SaveFile("docx", "ApiParaPr.docx");
builder.CloseFile();

Resulting document