Skip to main content

GetSpacingLineRule

Returns the paragraph line spacing rule.

Inherited from ApiParaPr.GetSpacingLineRule.

Syntax​

expression.GetSpacingLineRule();

expression - A variable that represents an ApiParagraph class.

Parameters​

This method doesn't have any parameters.

Returns​

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

Example​

Find out the line spacing type used in a paragraph in a PDF.

// How do I determine which line spacing rule applies to a paragraph in a PDF?

// Read the line spacing method assigned to a paragraph in a PDF.

const doc = Api.GetDocument();
const page = doc.GetPage(0);

const gs1 = Api.CreateGradientStop(Api.RGB(255, 213, 191), 0);
const gs2 = Api.CreateGradientStop(Api.RGB(255, 111, 61), 100000);
const fill = Api.CreateRadialGradientFill([gs1, gs2]);
const stroke = Api.CreateStroke(0, Api.CreateNoFill());
const shape = Api.CreateShape("flowChartMagneticTape", 150 * 36000, 65 * 36000, fill, stroke);
shape.SetPosition(608400, 1267200);
page.AddObject(shape);

const docContent = shape.GetContent();
const paragraph = docContent.GetElement(0);
paragraph.SetSpacingLine(3 * 240, "auto");
paragraph.AddText("Paragraph 1. Spacing: 3 times of a common paragraph line spacing.");
paragraph.AddLineBreak();
paragraph.AddText("These sentences are used to add lines for demonstrative purposes. ");
paragraph.AddText("These sentences are used to add lines for demonstrative purposes. ");
paragraph.AddLineBreak();

const spacingLineRule = paragraph.GetSpacingLineRule();
paragraph.AddText("Spacing line rule: " + spacingLineRule);