ApiHyperlink

Class representing a hyperlink.

Properties

Name	Type	Description
Address	string	Returns or sets the address of the target document.
Name	string	Returns the name of the hyperlink.
Range	ApiRange	Returns the range the hyperlink is attached to.
ScreenTip	string	Returns or sets the screen tip text for the hyperlink.
SubAddress	string	Returns or sets the subaddress of the target document.
TextToDisplay	string	Returns or sets the text to be displayed for the hyperlink.
Type	number	Returns the type of the hyperlink.

Methods

The following table lists the available methods.

Method	Returns	Description
Delete	None	Deletes the hyperlink.
GetAddress	string	Returns the address of the target document.
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.
GetName	string	Returns the name of the hyperlink.
GetRange	ApiRange	Returns the range the hyperlink is attached to.
GetScreenTip	string	Returns the screen tip text for the hyperlink.
GetScreenTipText	string	Returns the screen tip text of the hyperlink.
GetSubAddress	string	Returns the subaddress of the target document.
GetTextRange	ApiTextRange | null	Returns an ApiTextRange object that represents the part of the text contained in the current hyperlink.
GetTextToDisplay	string	Returns the text displayed for the hyperlink.
GetType	number	Returns the type of the hyperlink.
SetAddress	None	Sets the address of the target document.
SetLink	boolean	Sets the hyperlink address.
SetScreenTip	None	Sets the screen tip text for the hyperlink.
SetScreenTipText	boolean	Sets the screen tip text of the hyperlink.
SetSubAddress	None	Sets the subaddress of the target document.
SetTextToDisplay	None	Sets the text to be displayed for the hyperlink.