GetElement

Returns the hyperlink element using the position specified.

Syntax

expression.GetElement(nPos);

expression - A variable that represents a ApiHyperlink class.

Parameters

Name	Required/Optional	Data type	Default	Description
nPos	Required	number		The position where the element which content we want to get must be located.

Returns

ParagraphContent

Example

Return the hyperlink element using the position specified in a presentation.

// How can I get the element using a hyperlink in a presentation?

// Get the element for a hyperlink in a presentation.

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

const fill = Api.CreateSolidFill(Api.RGB(244, 206, 206));
const stroke = Api.CreateStroke(0, Api.CreateNoFill());
const shape = Api.CreateShape('rect', Api.MillimetersToEmus(300), Api.MillimetersToEmus(130), fill, stroke);
shape.SetPosition(Api.MillimetersToEmus(20), Api.MillimetersToEmus(35));

const docContent = shape.GetContent();
const paragraph = docContent.GetElement(0);
const run1 = Api.CreateRun();
run1.AddText('Api Document Builder.');
paragraph.AddElement(run1, 0);
const run2 = Api.CreateRun();
run2.AddText(' ONLYOFFICE for developers');
paragraph.AddElement(run2, 1);

const infoParagraph = Api.CreateParagraph();
let hyperlink, element;

hyperlink = paragraph.AddHyperlink('https://api.onlyoffice.com/docbuilder/basic');
element = hyperlink.GetElement(0);
if (element) {
	infoParagraph.AddText('The element at position 0 in the text hyperlink is: ' + element.GetText());
} else {
	infoParagraph.AddText('There is no element at position 0 in the text hyperlink.');
}
infoParagraph.AddLineBreak();

shape.SetHyperlink(Api.CreateHyperlink('https://api.onlyoffice.com/', 'ONLYOFFICE website'));
hyperlink = shape.GetHyperlink();
element = hyperlink.GetElement(0);
if (element) {
	infoParagraph.AddText('The element at position 0 in the shape hyperlink is: ' + element.GetText());
	infoParagraph.AddElement(element);
} else {
	infoParagraph.AddText('There is no element at position 0 in the shape hyperlink.');
}

docContent.Push(infoParagraph);
slide.AddObject(shape);