Visio.Hyperlink class

包:

visio

表示 Hyperlink 对象。

Extends

OfficeExtension.ClientObject

注解

[ API 集： 1.1 ]

属性

address	获取超链接对象的地址。
context	与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
description	获取超链接的说明。
extraInfo	获取用于解析超链接 URL 的额外 URL 请求信息。
subAddress	获取超链接对象的子地址。

方法

load(options)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
setMockData(data)	设置模拟数据
toJSON()	重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来，调用toJSON传递给它的 对象的 方法。) 而原始 Visio.Hyperlink 对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Visio.Interfaces.HyperlinkData) ，该对象包含原始对象中任何已加载子属性的浅表副本。

属性详细信息

address

获取超链接对象的地址。

readonly address: string;

属性值

string

注解

[ API 集： 1.1 ]

context

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

context: RequestContext;

属性值

Visio.RequestContext

description

获取超链接的说明。

readonly description: string;

属性值

string

注解

[ API 集： 1.1 ]

extraInfo

获取用于解析超链接 URL 的额外 URL 请求信息。

readonly extraInfo: string;

属性值

string

注解

[ API 集： 1.1 ]

subAddress

获取超链接对象的子地址。

readonly subAddress: string;

属性值

string

注解

[ API 集： 1.1 ]

方法详细信息

load(options)

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

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

参数

options

Visio.Interfaces.HyperlinkLoadOptions

提供要加载对象的属性的选项。

返回

Visio.Hyperlink

示例

Visio.run(session, function (ctx) {
    const activePage = ctx.document.getActivePage();
    const shape = activePage.shapes.getItem(0);
    const hyperlink = shape.hyperlinks.getItem(0);
    hyperlink.load();
    return ctx.sync().then(function() {
        console.log(hyperlink.description);
        console.log(hyperlink.address);
        console.log(hyperlink.subAddress);
        console.log(hyperlink.extraInfo);
     });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

load(propertyNames)

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

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

参数

propertyNames

string | string[]

逗号分隔的字符串或指定要加载的属性的字符串数组。

返回

Visio.Hyperlink

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。

返回

Visio.Hyperlink

setMockData(data)

设置模拟数据

setMockData(data: Visio.Interfaces.HyperlinkData): void;

参数

data

Visio.Interfaces.HyperlinkData

返回

void

toJSON()

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

toJSON(): Visio.Interfaces.HyperlinkData;

返回

Visio.Interfaces.HyperlinkData