Word.Hyperlink class
表示 Word 文档中的超链接。
属性
| address | 指定地址 (例如，超链接的文件名或 URL) 。 |
| context | 与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。 |
| email |
指定超链接主题行的文本字符串。 |
| is |
如果需要其他信息来解析超链接，则返回 |
| name | 返回对象的 |
| range | 返回表示 |
| screen |
指定当鼠标指针位于超链接上时显示为屏幕提示的文本。 |
| sub |
指定超链接目标中的命名位置。 |
| target | 指定要在其中加载超链接的帧或窗口的名称。 |
| text |
指定文档中的超链接可见文本。 |
| type | 返回超链接的类型。 |
方法
| add |
创建文档或超链接的快捷方式并将其添加到 “收藏夹” 文件夹。 |
| create |
创建链接到超链接的新文档。 |
| delete() | 删除超链接。 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。 |
| set(properties) | 基于现有加载的对象，同时在对象上设置多个属性。 |
| toJSON() | 覆盖 JavaScript |
| track() | 根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果在调用中 |
| untrack() | 释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 需要在内存释放生效之前调用 |
属性详细信息
address
context
emailSubject
isExtraInfoRequired
如果需要其他信息来解析超链接，则返回 true 。
readonly isExtraInfoRequired: boolean;属性值
boolean
注解
name
range
screenTip
subAddress
target
textToDisplay
type
返回超链接的类型。
readonly type: Word.HyperlinkType | "Range" | "Shape" | "InlineShape";属性值
Word.HyperlinkType | "Range" | "Shape" | "InlineShape"
注解
方法详细信息
addToFavorites()
createNewDocument(fileName, editNow, overwrite)
创建链接到超链接的新文档。
createNewDocument(fileName: string, editNow: boolean, overwrite: boolean): void;参数
- fileName
-
string
文件的名称。
- editNow
-
boolean
true 立即开始编辑。
- overwrite
-
boolean
true 如果有另一个同名的文件，则覆盖。
返回
void
注解
delete()
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Word.Interfaces.HyperlinkLoadOptions): Word.Hyperlink;参数
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Word.Hyperlink;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.Hyperlink;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
set(properties, options)
同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。
set(properties: Interfaces.HyperlinkUpdateData, options?: OfficeExtension.UpdateOptions): void;参数
- properties
- Word.Interfaces.HyperlinkUpdateData
一个 JavaScript 对象，其属性与调用该方法的对象的属性同构结构。
- options
- OfficeExtension.UpdateOptions
提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止错误。
返回
void
set(properties)
toJSON()
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Word.Hyperlink 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 Word.Interfaces.HyperlinkData) ，其中包含从原始对象加载的任何子属性的浅层副本。
toJSON(): Word.Interfaces.HyperlinkData;返回
track()
根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果在调用中 .sync 使用此对象，并且在“.run”批处理的顺序执行之外使用此对象，并且在设置属性或对对象调用方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将对象添加到跟踪对象集合。 如果此对象是集合的一部分，您还应跟踪父集合。
track(): Word.Hyperlink;返回
untrack()
释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 需要在内存释放生效之前调用 context.sync() 。
untrack(): Word.Hyperlink;