Skip to main content

GetSpacingLineValue

Returns the paragraph line spacing value.

Syntax​

expression.GetSpacingLineValue();

expression - A variable that represents a ApiParaPr class.

Parameters​

This method doesn't have any parameters.

Returns​

twips | line240 | undefined

Example​

This example shows how to get the paragraph line spacing value.

let worksheet = Api.GetActiveSheet();
let fill = Api.CreateSolidFill(Api.CreateRGBColor(255, 111, 61));
let stroke = Api.CreateStroke(0, Api.CreateNoFill());
let shape = worksheet.AddShape("flowChartOnlineStorage", 120 * 36000, 70 * 36000, fill, stroke, 0, 2 * 36000, 0, 3 * 36000);
let content = shape.GetContent();
let paragraph = content.GetElement(0);
let paraPr = paragraph.GetParaPr();
paraPr.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.");
let spacingLineValue = paraPr.GetSpacingLineValue();
paragraph = Api.CreateParagraph();
paragraph.AddText("Spacing line value : " + spacingLineValue);
content.Push(paragraph);