Skip to main content

AddElement

Adds an element to the current paragraph.

Syntax​

expression.AddElement(oElement, nPos);

expression - A variable that represents a ApiParagraph class.

Parameters​

NameRequired/OptionalData typeDefaultDescription
oElementRequiredParagraphContentThe document element which will be added at the current position. Returns false if the oElement type is not supported by a paragraph.
nPosOptionalnumberThe position where the current element will be added. If this value is not specified, then the element will be added at the end of the current paragraph.

Returns​

boolean

Example​

Insert a formatted text run into a paragraph inside a shape in a spreadsheet.

// How do I append a styled piece of text to an existing paragraph in a spreadsheet?

// Build a run with custom content and attach it to the paragraph as a new element 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, 70 * 36000, fill, stroke, 0, 2 * 36000, 0, 3 * 36000);
let content = shape.GetContent();
let paragraph = content.GetElement(0);
let run = Api.CreateRun();
run.AddText("This is just a sample text run. Nothing special.");
paragraph.AddElement(run);