ApiHyperlink

表示超链接的类。

属性

名称	类型	描述
Address	string	返回或设置目标文档的地址。
Name	string	返回超链接的名称。
Range	ApiRange	返回超链接所附加到的范围。
ScreenTip	string	返回或设置超链接的屏幕提示文本。
SubAddress	string	返回或设置目标文档的子地址。
TextToDisplay	string	返回或设置超链接的显示文本。
Type	number	返回超链接的类型。

方法

下表列出了可用的方法。

方法	返回值	描述
Delete	无	删除超链接。
GetAddress	string	返回目标文档的地址。
GetClassType	"hyperlink"	返回 ApiHyperlink 类的类型。
GetElement	ParagraphContent | null | undefined	使用指定的位置返回超链接元素。
GetElementsCount	number	返回当前超链接中的元素数量。
GetLinkedText	string	返回超链接地址。
GetName	string	返回超链接的名称。
GetRange	ApiRange	返回超链接所附加到的范围。
GetScreenTip	string	返回超链接的屏幕提示文本。
GetScreenTipText	string	返回超链接的屏幕提示文本。
GetSubAddress	string	返回目标文档的子地址。
GetTextRange	ApiTextRange | null	返回表示当前超链接中所含部分文本的 ApiTextRange 对象。
GetTextToDisplay	string	返回超链接的显示文本。
GetType	number	返回超链接的类型。
SetAddress	无	设置目标文档的地址。
SetLink	boolean	设置超链接地址。
SetScreenTip	无	设置超链接的屏幕提示文本。
SetScreenTipText	boolean	设置超链接的屏幕提示文本。
SetSubAddress	无	设置目标文档的子地址。
SetTextToDisplay	无	设置超链接的显示文本。