文档

Hyperlink

更新时间:

本文介绍文字文档Hyperlink相关的API。

Hyperlinks

ActiveDocument.Hyperlinks

获取文档中的所有超链接。

重要
  • JS-SDK V1.1.10及以上版本支持此功能。

  • 仅PC端支持此功能。

  • 语法

    表达式.ActiveDocument.Hyperlinks

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取文档中的所有超链接
      const hyperlinks = await app.ActiveDocument.Hyperlinks;
    }

方法

ActiveDocument.Hyperlinks.Add()

通过Add()方法,您可以插入超链接。

重要
  • JS-SDK V1.1.10及以上版本支持此功能。

  • 仅PC端支持此功能。

  • 语法

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

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    Address

    String

    插入的链接地址。

    TextToDisplay

    String

    超链接显示的文本。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //插入超链接
      await app.ActiveDocument.Hyperlinks.Add({
        Address: 'https://www.aliyun.com/', //插入的链接地址
        TextToDisplay: '阿里云官网', //超链接显示的文本
      });
    }

属性

ActiveDocument.Hyperlinks.Count

通过Count属性,您可以获取所有超链接的总数量。

重要

JS-SDK V1.1.16及以上版本支持此功能。

  • 语法

    表达式.ActiveDocument.Hyperlinks.Count

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //获取所有超链接的总数量
      await app.ActiveDocument.Hyperlinks.Count;
    }

Hyperlink

ActiveDocument.Hyperlinks.Item()

获取单个超链接对象。

重要

JS-SDK V1.1.16及以上版本支持此功能。

  • 语法

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

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取单个超链接对象
      const shapes = await app.ActiveDocument.Hyperlinks.Item(Index);
    }

属性

ActiveDocument.Hyperlinks.Item(Index).Address

通过Address属性,您可以设置和获取超链接的地址。

重要

JS-SDK V1.1.16及以上版本支持此功能。

  • 语法

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

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
        
      //获取超链接地址
      const address = await app.ActiveDocument.Hyperlinks.Item(1).Address
    }

ActiveDocument.Hyperlinks.Item(Index).TextToDisplay

通过TextToDisplay属性,您可以设置和获取超链接显示的文本。

重要

JS-SDK V1.1.16及以上版本支持此功能。

  • 语法

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

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
        
      //获取超链接显示的文本
      const TextToDisplay = await app.ActiveDocument.Hyperlinks.Item(1).TextToDisplay
    }