评论

本文介绍使用文字文档时如何查看文档是否有评论,获取全文评论,控制评论是否显示以及删除所有评论。

查看是否有评论

查看文档是否有评论。

  • 语法

    表达式.ActiveDocument.HasComments()

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

  • 返回值

    类型为Boolean。当返回值为true时,表示文档有评论,当返回值为false时,表示文档无评论。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //查看文档是否有评论
      const hasComments = await app.ActiveDocument.HasComments();
      console.log(hasComments); //返回值为true或者false。
    }

获取全文评论

获取全文的评论。

  • 语法

    表达式.ActiveDocument.GetComments({ Offset, Limit })

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

  • 参数

    重要

    由于文字文档是流式排版,在使用大文档且Limit - Offset较大时,获取时间会比较长,建议增加一个中间loading过渡效果。

    属性

    数据类型

    是否必选

    描述

    Offset

    Number

    起始位置。

    Limit

    Number

    限制条数。

  • 返回值

    Array.<Object>

    返回值包含的属性请参见下表。

    属性

    数据类型

    描述

    auth

    String

    评论人。

    content

    String

    内容。

    date

    Date

    评论时间。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取全文评论
      const operatorsInfo = await app.ActiveDocument.GetComments({ Offset: 0, Limit: 20 });
      console.log(operatorsInfo);
    }

控制评论是否显示

控制文档是否显示评论。

  • 语法

    表达式.ActiveDocument.ActiveWindow.View.ShowComments = Boolean

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

    当设置Booleantrue时,表示显示文档评论,设置Booleanfalse时,表示隐藏文档评论。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //隐藏文档评论
      app.ActiveDocument.ActiveWindow.View.ShowComments = false;
    }

删除所有评论

删除文档中的所有评论。

  • 语法

    表达式.ActiveDocument.DeleteAllComments()

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //删除文档中的所有评论
      await app.ActiveDocument.DeleteAllComments();
    }