Visio.HyperlinkCollection class

包:
visio

表示 HyperlinkCollection 对象。

扩展
OfficeExtension.ClientObject

注解

API 集：1.1

使用方

属性

context

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

获取此集合中已加载的子项。

方法

getCount()

获取超链接的数量。
getItem(Key)

按键（名称或 ID）获取超链接。
load(options)

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

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

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

覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Visio.HyperlinkCollection 对象是 API 对象， toJSON 但该方法返回一个普通的 JavaScript 对象， (类型为 Visio.Interfaces.HyperlinkCollectionData) ，其中包含一个“项”数组，其中包含从集合项中加载的任何属性的浅层副本。

属性详细信息

context

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

context: RequestContext;

属性值

Visio.RequestContext

items

获取此集合中已加载的子项。

readonly items: Visio.Hyperlink[];

属性值

Visio.Hyperlink[]

方法详细信息

getCount()

获取超链接的数量。

getCount(): OfficeExtension.ClientResult<number>;

返回

OfficeExtension.ClientResult<number>

注解

API 集：1.1

getItem(Key)

按键（名称或 ID）获取超链接。

getItem(Key: number | string): Visio.Hyperlink;

参数

Key

number | string

键是要检索的超链接的名称或索引。

返回

Visio.Hyperlink

注解

API 集：1.1

load(options)

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

load(options?: Visio.Interfaces.HyperlinkCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions): Visio.HyperlinkCollection;

参数

options

Visio.Interfaces.HyperlinkCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions

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

返回

Visio.HyperlinkCollection

示例

Visio.run(session, function (ctx) {
    const activePage = ctx.document.getActivePage();
    const shapeName = "Manager Belt";
    const shape = activePage.shapes.getItem(shapeName);
    const shapeHyperlinks = shape.hyperlinks;
    shapeHyperlinks.load(["description", "address", "subAddress"]);
        ctx.sync().then(function () {
            for (let i = 0; i < shapeHyperlinks.items.length; i++) {
                const hyperlink = shapeHyperlinks.items[i];
                console.log(
                    "Description:"+hyperlink.description +"Address:"+hyperlink.address +"SubAddress:  " + 
                    hyperlink.subAddress);
            }
        });
}).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.HyperlinkCollection;

参数

propertyNames

string | string[]

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

返回

Visio.HyperlinkCollection

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Visio.HyperlinkCollection;

参数

propertyNamesAndPaths
OfficeExtension.LoadOption

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

返回

Visio.HyperlinkCollection

toJSON()

覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Visio.HyperlinkCollection 对象是 API 对象， toJSON 但该方法返回一个普通的 JavaScript 对象， (类型为 Visio.Interfaces.HyperlinkCollectionData) ，其中包含一个“项”数组，其中包含从集合项中加载的任何属性的浅层副本。

toJSON(): Visio.Interfaces.HyperlinkCollectionData;

返回

Visio.Interfaces.HyperlinkCollectionData