Skip to main content

GetSpacingLineValue

Returns the paragraph line spacing value.

Inherited from ApiParaPr.GetSpacingLineValue.

Syntax​

expression.GetSpacingLineValue();

expression - A variable that represents an ApiParagraph class.

Parameters​

This method doesn't have any parameters.

Returns​

twips | line240 | undefined

Example​

Read the numeric line spacing value of a paragraph inside a shape in a spreadsheet.

// How do I check the exact line height set for a paragraph in a spreadsheet?

// Confirm the line spacing amount after applying a custom multiplier to a paragraph in a spreadsheet.

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