Skip to main content

ExpandTo

Returns a new range that spans both this range and the given range. The current range is not changed.

Syntax​

expression.ExpandTo(range);

expression - A variable that represents an ApiTextRange class.

Parameters​

NameRequired/OptionalData typeDefaultDescription
rangeRequiredApiTextRangeNo description provided.

Returns​

ApiTextRange | null

Example​

Join two text ranges into one in a shape on a PDF page.

// The union covers everything from the first start to the last end, including the text between them.

// Join the first and the last word and make the whole fragment italic.

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("rect", 200 * 36000, 80 * 36000, fill, stroke);
shape.SetPosition(608400, 1267200);
page.AddObject(shape);

const docContent = shape.GetContent();
const paragraph = docContent.GetElement(0);
paragraph.AddText("Hello brave World");

const range = shape.GetTextRange();

const first = range.GetRange(0, 5);
const second = range.GetRange(12, 17);
const united = first.ExpandTo(second);
united.SetItalic(true);

const reportFill = Api.CreateSolidFill(Api.RGB(200, 230, 255));
const report = Api.CreateShape("rect", 200 * 36000, 40 * 36000, reportFill, stroke);
report.SetPosition(608400, 4000000);
page.AddObject(report);
report.GetContent().GetElement(0).AddText("ExpandTo: " + united.GetText());