文档

Comment

更新时间:

本文介绍与文字文档Comment相关的API。

Comments

ActiveDocument.Comments

获取文档的所有评论。

重要

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

  • 语法

    表达式.ActiveDocument.Comments

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取所有评论
      const Comments = await app.ActiveDocument.Comments;
    }

方法

ActiveDocument.Comments.Add()

通过Add()方法,您可以添加评论。

重要

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

  • 语法

    表达式.ActiveDocument.Comments.Add({ Range, Text })

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    Range

    Object

    评论的文本区域。

    Text

    String

    评论内容。

  • Range说明

    属性

    数据类型

    是否必填

    描述

    Start

    Number

    设置评论的起点。

    End

    Number

    设置评论的终点。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //获取所有评论
      const comments = await app.ActiveDocument.Comments;
    
      //添加评论
      await comments.Add({
        Range: {
          Start: 0,
          End: 9,
        },
        Text: 'Aliyun 评论',
      });
    }

ActiveDocument.Comments.DeleteComment()

通过DeleteComment()方法,您可以根据位置信息删除指定评论。

重要

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

  • 语法

    表达式.ActiveDocument.Comments.DeleteComment({ Start, Length })

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    Start

    Number

    评论的起始位置。

    Length

    Number

    评论文本的长度,单位为字节。

  • 示例

    //@file=base.docx
    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //评论对象
      const comments = await app.ActiveDocument.Comments;
    
      //添加评论
      await comments.Add({
        Range: {
          Start: 0,
          End: 9,
        },
        Text: '评论',
      });
    
      //删除评论
      await comments.DeleteComment({
        Start: 0,
        Length: 9,
      });
    }

ActiveDocument.Comments.DeleteCommentById()

说明

可以通过获取全文评论方法来查看对应评论的ID信息。

通过DeleteCommentById()方法,您可以根据评论ID删除评论。

重要

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

  • 语法

    表达式.ActiveDocument.Comments.DeleteCommentById({ CommentId })

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    CommentId

    String

    评论id,可通过 ActiveDocument.GetComments 获取全文评论(含评论id)

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      // 评论对象
      const comments = await app.ActiveDocument.Comments;
    
      // 删除评论
      await comments.DeleteCommentById({
        CommentId: '1234567890'
      });
    }

ActiveDocument.Comments.GetCommentReferenceText()

通过GetCommentReferenceText()方法,您可以获取评论的引用文本。

重要

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

  • 语法

    表达式.ActiveDocument.Comments.GetCommentReferenceText({ CommentId })

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    CommentId

    String

    评论id,可通过 ActiveDocument.GetComments 获取全文评论(含评论id)

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      // 评论对象
      const comments = await app.ActiveDocument.Comments;
    
      // 获取评论引用文本
      await comments.GetCommentReferenceText({
        CommentId: '1234567890'
      });
    }

ActiveDocument.Comments.GoToComment()

通过GoToComment()方法,您可以跳转到评论。

重要

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

  • 语法

    表达式.ActiveDocument.Comments.GoToComment({ CommentId })

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    CommentId

    String

    评论id,可通过 ActiveDocument.GetComments 获取全文评论(含评论id)

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      // 评论对象
      const comments = await app.ActiveDocument.Comments;
    
      // 跳转到评论
      await comments.GoToComment({
        CommentId: '1234567890'
      });
    }

ActiveDocument.Comments.ModifyComment()

通过ModifyComment()方法,您可以修改评论内容。

重要

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

  • 语法

    表达式.ActiveDocument.Comments.ModifyComment({ CommentId, Text })

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    CommentId

    String

    评论id,可通过 ActiveDocument.GetComments 获取全文评论(含评论id)

    Text

    String

    新的评论内容

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      // 评论对象
      const comments = await app.ActiveDocument.Comments;
    
      // 修改评论内容
      await comments.ModifyComment({
        CommentId: '1234567890',
        Text: '新的评论内容'
      });
    }

ActiveDocument.Comments.ReplyComment()

通过ReplyComment()方法,您可以回复评论。

重要

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

  • 语法

    表达式.ActiveDocument.Comments.ReplyComment({ CommentId, Text })

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    CommentId

    String

    所回复评论的ID,可通过ActiveDocument.GetComments获取全文评论(含CommentId)。

    Text

    String

    回复的内容。

  • 返回值

    WebOffice v4.2.1+ 支持返回评论数据。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //获取所有评论
      const comments = await app.ActiveDocument.Comments;
    
      //添加评论
      await comments.Add({
        Range: {
          CommentId: 0,
          End: 9,
        },
        Text: 'Aliyun 评论',
      });
    
      //获取第1条评论
      const comments = await WPSOpenApi.Application.ActiveDocument.GetComments();
      const firstCommentId = comments[0].commentId;
    
      //回复评论
      await comments.ReplyComment({
        CommentId: firstCommentId,
        Text: '回复第一条评论',
      });
    }