本文介绍与表格文档Hyperlink相关的API。
Hyperlinks
app.ActiveSheet.Hyperlinks
JS-SDK V1.1.16及以上版本支持该功能。
获取文档中的所有超链接的集合。
语法
表达式.app.ActiveSheet.Hyperlinks
表达式:文档类型应用对象
示例
//@file=base.docx async function example() { await instance.ready(); const app = instance.Application; //获取超链接对象 const hyperlinks = await app.app.ActiveSheet.Hyperlinks; }
方法
app.ActiveSheet.Hyperlinks.Item()
JS-SDK V1.1.16及以上版本支持该功能。
获取超链接对象。
语法
表达式.app.ActiveSheet.Hyperlinks.Item(Index)
表达式:文档类型应用对象
参数
属性
数据类型
是否必填
描述
Index
number
是
超链接Index,值从1开始。
返回值
返回
Hyperlink
超链接对象示例
//@file=base.Excel async function example() { await instance.ready(); const app = instance.Application; //获取超链接单个对象 await app.app.ActiveSheet.Hyperlinks.Item(1); }
app.ActiveSheet.Hyperlinks.Delete()
删除超链接
JS-SDK V1.1.19及以上版本支持该功能。
语法
表达式.app.ActiveSheet.Hyperlinks.Delete()
表达式:文档类型应用对象
示例
async function example() { await instance.ready(); const app = instance.Application; // 删除超链接 await app.ActiveSheet.Hyperlinks.Delete(); }
属性
app.ActiveSheet.Hyperlinks.Count
通过Count
属性,您可以获取超链接对象集合的数量。
语法
表达式.app.ActiveSheet.Hyperlinks.Count
表达式:文档类型应用对象
示例
//@file=base.xlsx async function example() { await instance.ready(); const app = instance.Application; //获取超链接的数量 await app.app.ActiveSheet.Hyperlinks.Count; }
Hyperlink
app.ActiveSheet.Hyperlinks.Item(Index)
JS-SDK V1.1.16及以上版本支持该功能。
获取超链接对象。
语法
表达式.app.ActiveSheet.Hyperlinks.Item(Index)
表达式:文档类型应用对象
参数
属性
数据类型
是否必填
描述
Index
number
是
超链接Index,值从1开始。
返回值
返回
Hyperlink
超链接对象示例
//@file=base.Excel async function example() { await instance.ready(); const app = instance.Application; //获取超链接单个对象 await app.app.ActiveSheet.Hyperlinks.Item(1); }
属性
app.ActiveSheet.Hyperlinks.Item(Index).Address
通过Address
属性,您可以设置和获取执行超链接的地址。
语法
表达式.app.ActiveSheet.Hyperlinks.Item(Index).Address
表达式:文档类型应用对象
示例
//@file=base.xlsx async function example() { await instance.ready(); const app = instance.Application; //获取超链接地址 const address = await app.app.ActiveSheet.Hyperlinks.Item(1).Address }
app.ActiveSheet.Hyperlinks.Item(Index).TextToDisplay
通过TextToDisplay
属性,您可以设置和获取执行超链接的文本。
语法
表达式.app.ActiveSheet.Hyperlinks.Item(Index).TextToDisplay
表达式:文档类型应用对象
示例
//@file=base.xlsx async function example() { await instance.ready(); const app = instance.Application; //获取超链接文本 const TextToDisplay = await app.app.ActiveSheet.Hyperlinks.Item(1).TextToDisplay }