Visio.Hyperlink class
表示 Hyperlink 对象。
属性
| address | 获取超链接对象的地址。 |
| context | 与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。 |
| description | 获取超链接的说明。 |
| extra |
获取用于解析超链接 URL 的额外 URL 请求信息。 |
| sub |
获取超链接对象的子地址。 |
方法
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| toJSON() | 覆盖 JavaScript |
属性详细信息
address
context
description
extraInfo
subAddress
方法详细信息
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(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[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Visio.Hyperlink;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
toJSON()
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Visio.Hyperlink 对象是 API 对象，但该 toJSON 方法返回 (类型化为 Visio.Interfaces.HyperlinkData) 的纯 JavaScript 对象，其中包含从原始对象加载的任何子属性的浅层副本。
toJSON(): Visio.Interfaces.HyperlinkData;