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.
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.
GetScreenTipText	string	Returns the screen tip text of the hyperlink.
GetTextRange	ApiTextRange | null	Returns an ApiTextRange object that represents the part of the text contained in the current hyperlink.
SetLink	boolean	Sets the hyperlink address.
SetScreenTipText	boolean	Sets the screen tip text of the hyperlink.