超链接(Hyperlinks)

文档中的所有超链接的集合

属性列表

属性	说明
Count	超链接对象集合的数量

方法列表

方法	说明
Add()	在选区位置插入超链接
Item()	获取超链接对象
Item().Address	设置/获取执行超链接的地址
Item().TextToDisplay	设置/获取执行超链接的文本

Count

超链接对象集合的数量

语法

表达式.ActiveDocument.Hyperlinks.Count

表达式：文档类型应用对象

示例

//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取超链接d的数量
  await app.ActiveDocument.Hyperlinks.Count
}

Add()

仅支持 PC 端

在选区位置插入超链接

语法

表达式.ActiveDocument.Hyperlinks.Add({ Address, TextToDisplay })

表达式：文档类型应用对象

参数

属性	数据类型	默认值	必填	说明
Address	String		是	插入的链接地址
TextToDisplay	String		否	超链接展示的文本

示例

//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 在选区位置插入超链接
  await app.ActiveDocument.Hyperlinks.Add({
    Address: 'https://open.wps.cn/', // 插入的链接地址
    TextToDisplay: 'WPS开放平台' // 超链接展示的文本
  })
}

Item()

获取超链接对象

语法

表达式.ActiveDocument.Hyperlinks.Item(Index)

表达式：文档类型应用对象

参数

属性	数据类型	默认值	必填	说明
Index	number		是	幻灯片序列 从 1 开始

返回值

返回 Hyperlink 超链接对象

示例

//@file=base.Word
async function example() {
  await instance.ready()

  const app = instance.Application
  // 获取超链接单个对象
  await app.ActiveDocument.Hyperlinks.Item(1)
}

Item().Address

设置/获取执行超链接的地址

语法

表达式.ActiveDocument.Hyperlinks.Item(Index).Address

表达式：文档类型应用对象

示例

//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  //获取超链接地址
  const address = await app.ActiveDocument.Hyperlinks.Item(1).Address
}

Item().TextToDisplay

设置/获取执行超链接的文本

语法

表达式.ActiveDocument.Hyperlinks.Item(Index).TextToDisplay

表达式：文档类型应用对象

示例

//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  //获取超链接地址
  const TextToDisplay = await app.ActiveDocument.Hyperlinks.Item(1)
    .TextToDisplay
}