Get Started
Usage API
More information

GetSpacingLineRule

GetSpacingLineRule() → { "auto" | "atLeast" | "exact" | undefined }

Get the paragraph line spacing rule.

Parameters:

This method doesn't have any parameters.

Returns:

Type
"auto" | "atLeast" | "exact" | undefined

Example

Copy code
builder.CreateFile("docx");
oDocument = Api.GetDocument();
oParagraph = oDocument.GetElement(0);
oParaPr = oParagraph.GetParaPr();
oParaPr.SetSpacingLine(3 * 240, "auto");
oParagraph.AddText("Paragraph 1. Spacing: 3 times of a common paragraph line spacing.");
oParagraph.AddLineBreak();
oParagraph.AddText("These sentences are used to add lines for demonstrative purposes. ");
oParagraph.AddText("These sentences are used to add lines for demonstrative purposes. ");
oParagraph.AddLineBreak();
sSpacingLineRule = oParaPr.GetSpacingLineRule();
oParagraph.AddText("Spacing line rule: " + sSpacingLineRule);
builder.SaveFile("docx", "GetSpacingLineRule.docx");
builder.CloseFile();

Resulting document