文档

Sub

更新时间:

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

Sub.ClipboardCopy

监听剪切板复制事件。

重要

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

  • 语法

    表达式.Sub.ClipboardCopy = Function

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

  • 返回值

    属性

    数据类型

    描述

    copyId

    String

    剪切板ID。

    isRestoreFocus

    Boolean

    是否复原焦点。

    text

    String

    复制的内容。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //监听剪切板复制事件
      app.Sub.ClipboardCopy = (e) => {
        console.log(e);
      }
    }

Sub.CurrentPageChange

监听当前页码改变事件。

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

  • 仅PC端支持此功能。

  • 语法

    表达式.Sub.CurrentPageChange = Function

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //监听当前页码改变事件
      app.Sub.CurrentPageChange = (e) => {
        console.log('当前页改变:', e);
      };
    }

Sub.DocMapPanelChange

监听目录的显示或隐藏事件。

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

  • 仅PC端支持此功能。

  • 语法

    表达式.Sub.DocMapPanelChange = Function

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //监听目录的显示或隐藏事件
      app.Sub.DocMapPanelChange = (e) => {
        console.log('目录侧边栏显示:', e);
      };
    }

Sub.DropdownListControlItemChange

监听下拉选项的更改事件。

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

  • 仅PC端支持此功能。

  • 语法

    表达式.Sub.DocMapPanelChange = Function

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //监听下拉选项的更改事件
      app.Sub.DropdownListControlItemChange = (e) => {
        console.log('监听下拉选项的更改', e);
        /* 返回信息结构:
           {
            Pos: Number, //位置信息
            Type: String, //“Select”为选中,“UnSelect”为取消选中
            Info: {
              Text: String, //显示文本
              Value: String, //编程值
            },
          }
        */
      };
    }

Sub.ViewModeChange

监听页面的版式变化事件。

重要

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

  • 语法

    表达式.Sub.ViewModeChange = Function

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //监听页面版式变化事件
      app.Sub.ViewModeChange = (d) => {
        console.log(d); //“web”为连页模式,“pages”为分页模式
      }
    }

Sub.WindowScrollChange

监听文档滚动事件。

重要

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

  • 语法

    表达式.Sub.WindowScrollChange = Function

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //监听文档滚动事件
      app.Sub.WindowScrollChange = ({ Data }) => {
       
    console.log(Data.scrollLeft, Data.scrollTop);
      }
    }

Sub.WindowSelectionChange

监听选区变化事件。

重要

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

  • 语法

    表达式.Sub.WindowSelectionChange = Function

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //监听选区变化事件
      app.Sub.WindowSelectionChange = (e) => {
        const { begin, end } = e;
    
        console.log(`选区开始位置:${begin}, 选区结束位置:${end}`);
      }
    
    

Sub.AddComment

监听新增评论事件。

重要

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

  • 语法

    表达式.Sub.AddComment = Function

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

  • 返回值

    属性

    数据类型

    描述

    author

    String

    评论所属用户的名称。

    pos

    Number

    评论对应正文内容的起始位置。

    len

    Number

    评论对应正文的长度。

    commentId

    String

    评论ID。

    说明

    每个评论不一定有commentId,但会有对应的rcid,当commentId不存在时,可以通过rcid判断。

    rcId

    String

    评论ID。

    replyCommentId

    String

    回复评论的ID。

    type

    String

    类型。

    content

    String

    评论内容。

    date

    String

    评论时间。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
       //监听新增评论事件
      app.Sub.AddComment = (e) => {
        console.log(e);
      }
    }

Sub.RemoveComment

监听删除评论事件。

重要

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

  • 语法

    表达式.Sub.RemoveComment = Function

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

  • 返回值

    属性

    数据类型

    描述

    author

    String

    评论所属用户的名称。

    pos

    Number

    评论对应正文内容的起始位置。

    len

    Number

    评论对应正文的长度。

    commentId

    String

    评论ID。

    说明

    每个评论不一定有commentId,但会有对应的rcid,当commentId不存在时,可以通过rcid判断。

    rcId

    String

    评论ID。

    replyCommentId

    String

    回复评论的ID。

    type

    String

    类型。

    content

    String

    评论内容。

    date

    String

    评论时间。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
       //监听删除评论事件
      app.Sub.RemoveComment = (e) => {
        console.log(e);
      }
    }

Sub.EditComment

监听编辑评论事件。

重要

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

  • 语法

    表达式.Sub.EditComment = Function

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

  • 返回值

    属性

    数据类型

    描述

    author

    String

    评论所属用户的名称。

    pos

    Number

    评论对应正文内容的起始位置。

    len

    Number

    评论对应正文的长度。

    commentId

    String

    评论ID。

    说明

    每个评论不一定有commentId,但会有对应的rcId,当commentId不存在时,可以通过rcId判断。

    rcId

    String

    评论ID。

    replyCommentId

    String

    回复评论的ID。

    type

    String

    类型。

    content

    String

    评论内容。

    date

    String

    评论时间。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
       //监听编辑评论事件
      app.Sub.EditComment = (e) => {
        console.log(e);
      }
    }

Sub.FontMissing

监听字体丢失事件。

重要

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

  • 语法

    表达式.Sub.FontMissing = Function

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //监听字体丢失事件
      app.Sub.FontMissing = (e) => {
        console.log(e);
      }
    }

Sub.DocMapItemClick

监听大纲目录点击事件。

重要

仅PC端支持此功能。

  • 语法

    表达式.Sub.DocMapItemClick = Function

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

  • 示例

    //@file=base.docx
    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      app.Sub.DocMapItemClick = (e) => {
        console.log(e);
      }
    }

Sub.ControlItemClick

监听内容控件点击事件。

重要

JS-SDK V1.1.19及以上版本支持此功能,且仅PC端支持此功能。

  • 语法

    表达式.Sub.ControlItemClick = Function

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

  • 示例

    async function example() {
    	await instance.ready();
     	const app = instance.Application;
     	app.Sub.ControlItemClick = (e) => {
     	console.log(e);
     }
    }

Sub.ContentChange

监听文档内容改变事件。

重要

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

  • 语法

    表达式.Sub.ContentChange = Function

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

  • async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      app.Sub.ContentChange = (e) => {
        console.log(e);
      }
    }