Word.Hyperlink class

指定地址 (例如，超链接的文件名或 URL) 。

address: string;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

指定超链接的主题行的文本字符串。

emailSubject: string;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

true如果解析超链接需要额外信息，则返回 。

readonly isExtraInfoRequired: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

返回对象的名称 Hyperlink 。

readonly name: string;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

返回一个 Range 对象，该对象表示超链接中包含的文档部分。

readonly range: Word.Range;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定当鼠标指针位于超链接上时显示为屏幕提示的文本。

screenTip: string;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定超链接目标中的命名位置。

subAddress: string;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定要在其中加载超链接的框架或窗口的名称。

target: string;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定文档中超链接的可见文本。

textToDisplay: string;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

返回超链接的类型。

readonly type: Word.HyperlinkType | "Range" | "Shape" | "InlineShape";

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

创建文档或超链接的快捷方式，并将其添加到 “收藏夹” 文件夹中。

addToFavorites(): void;

返回

注解

[ API 集：WordApiDesktop 1.3 ]

创建链接到超链接的新文档。

createNewDocument(fileName: string, editNow: boolean, overwrite: boolean): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

删除超链接。

delete(): void;

返回

注解

[ API 集：WordApiDesktop 1.3 ]

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(options?: Word.Interfaces.HyperlinkLoadOptions): Word.Hyperlink;

参数

返回

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNames?: string | string[]): Word.Hyperlink;

参数

返回

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.Hyperlink;

参数

返回

同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。

set(properties: Interfaces.HyperlinkUpdateData, options?: OfficeExtension.UpdateOptions): void;

参数

返回

基于现有的已加载对象，同时对对象设置多个属性。

set(properties: Word.Hyperlink): void;

参数

返回

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，依次调用toJSON传递给它的 对象的 方法。) 虽然原始Word.Hyperlink对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 Word.Interfaces.HyperlinkData) ，其中包含从原始对象加载的任何子属性的浅表副本。

toJSON(): Word.Interfaces.HyperlinkData;

返回

根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 .sync 调用和“.run”批处理的顺序执行外部使用此对象，并在设置属性或调用对象方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将该对象添加到跟踪的对象集合。 如果此对象是集合的一部分，则还应跟踪父集合。

track(): Word.Hyperlink;

返回

释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前，需要调用 context.sync() 。

untrack(): Word.Hyperlink;

返回