GetTextRange
Returns an ApiTextRange object that represents the part of the text contained in the current hyperlink.
Syntax
expression.GetTextRange(start, end);
expression - A variable that represents an ApiHyperlink class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| start | Optional | number | 0 | Start character position (0-based, inclusive) relative to the hyperlink. |
| end | Optional | number | End character position (0-based, exclusive). Defaults to the end of the hyperlink. |
Returns
ApiTextRange | null
Example
Make the text of a hyperlink in a shape on a PDF page italic through a text range.
// A hyperlink keeps its own runs, and the range covers exactly the text of the link.
// Take the range of the whole hyperlink text and apply italic to it.
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", 150 * 36000, 65 * 36000, fill, stroke);
shape.SetPosition(608400, 1267200);
page.AddObject(shape);
const docContent = shape.GetContent();
const paragraph = docContent.GetElement(0);
paragraph.AddText("Open ");
const hyperlink = paragraph.AddHyperlink("https://www.onlyoffice.com", "ONLYOFFICE");
const range = hyperlink.GetTextRange();
range.SetItalic(true);