Skip to main content

AddLineBreak

Adds a line break to the current position and starts the next element from a new line.

Syntax​

expression.AddLineBreak();

expression - A variable that represents a ApiParagraph class.

Parameters​

This method doesn't have any parameters.

Returns​

ApiRun

Example​

This example adds a line break to the current position and starts the next element from a new line.

// How to add a line break after a sentence in a paragraph.

// How to split a text with a line break.

const presentation = Api.GetPresentation();
const slide = presentation.GetSlideByIndex(0);
slide.RemoveAllObjects();

const gs1 = Api.CreateGradientStop(Api.CreateRGBColor(255, 213, 191), 0);
const gs2 = Api.CreateGradientStop(Api.CreateRGBColor(255, 111, 61), 100000);
const fill = Api.CreateRadialGradientFill([gs1, gs2]);
const stroke = Api.CreateStroke(0, Api.CreateNoFill());
const shape = Api.CreateShape("flowChartMagneticTape", 300 * 36000, 130 * 36000, fill, stroke);
shape.SetPosition(608400, 1267200);
const docContent = shape.GetDocContent();
const paragraph = docContent.GetElement(0);

paragraph.SetJc("left");
paragraph.AddText("This is a text inside the shape aligned left.");
paragraph.AddLineBreak();
paragraph.AddText("This is a text after the line break.");
slide.AddObject(shape);