AddLineBreak
Adds a line break to the current run position and starts the next element from a new line.
Syntax
expression.AddLineBreak();
expression - A variable that represents a ApiRun class.
Parameters
This method doesn't have any parameters.
Returns
boolean
Example
This example adds a line break to the run position and starts the next element from a new line.
- Code
- Result
// How to add a line break after a sentence in a text run.
// How to split a text with a line break.
const doc = Api.GetDocument();
const page = doc.GetPage(0);
const fill = Api.CreateSolidFill(Api.RGB(255, 111, 61));
const stroke = Api.CreateStroke(0, Api.CreateNoFill());
const shape = Api.CreateShape("flowChartMagneticTape", 150 * 36000, 65 * 36000, fill, stroke);
shape.SetPosition(608400, 1267200);
const docContent = shape.GetDocContent();
const paragraph = docContent.GetElement(0);
const run = Api.CreateRun();
run.AddText("This is the text for the first line. Nothing special.");
run.AddLineBreak();
run.AddText("This is the text which starts from the beginning of the second line. ");
run.AddText("It is written in two text runs, you need a space at the end of the first run sentence to separate them.");
paragraph.AddElement(run);
page.AddObject(shape);