ApiHyperlink

Class representing a Paragraph hyperlink.

Methods

The following table lists the available methods.

Method	Returns	Description
GetClassType	"hyperlink"	Returns a type of the ApiHyperlink class.
GetDisplayedText	string	Returns the hyperlink display text.
GetElement	ParagraphContent | null | undefined	Returns the hyperlink element using the position specified.
GetElementsCount	number	Returns a number of elements in the current hyperlink.
GetLinkedText	string	Returns the hyperlink address.
GetParent	ParagraphLikeContainer | null | undefined	Returns the parent element (a paragraph or an inline content control) that directly contains the current hyperlink.
GetPosInParent	Number	Returns the position (index) of the current hyperlink within its parent element.
GetRange	ApiRange	Returns a Range object that represents the document part contained in the specified hyperlink.
GetScreenTipText	string	Returns the screen tip text of the hyperlink.
SetDefaultStyle	boolean	Sets the default hyperlink style.
SetDisplayedText	boolean	Sets the hyperlink display text.
SetLink	boolean	Sets the hyperlink address.
SetScreenTipText	boolean	Sets the screen tip text of the hyperlink.
ToJSON	JSON	Converts the ApiHyperlink object into the JSON object.