与表格文档Sub相关的API有哪些_智能媒体管理(IMM)-阿里云帮助中心

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

Sub.Clipboard_Copy

监听剪切板复制事件。

语法
表达式.Sub.Clipboard_Copy = Function
表达式：文档类型应用对象
返回值
属性
数据类型
描述
copyId
String
剪切板ID。
isRestoreFocus
Boolean
是否复原焦点。
text
String
复制的内容。

示例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  //监听剪切板复制事件
  app.Sub.Clipboard_Copy = (e) => {
    console.log(e);
  }
}

Sub.Worksheet_Activate

监听活动工作表切换事件。

语法
表达式.Sub.Worksheet_Activate = Function
表达式：文档类型应用对象

示例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  //监听工作表切换事件
  app.Sub.Worksheet_Activate = async () => {
    console.log('ActiveSheet：', await app.ActiveSheet.Name);
  };
}

Sub.Worksheet_SelectionChange

监听选定内容改变事件。

语法
表达式.Sub.Worksheet_SelectionChange = Function
表达式：文档类型应用对象

示例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  //监听选区改变事件
  app.Sub.Worksheet_SelectionChange = (e) => {
    console.log('SelectionChange', e);
  };
}

Sub.Worksheet_ScrollChange

监听滚动改变事件。

语法
表达式.Sub.Worksheet_ScrollChange = Function
表达式：文档类型应用对象

示例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  //监听滚动改变事件
  app.Sub.Worksheet_ScrollChange = () => {
    console.log('ScrollChange');
  };
}

Sub.Window_Blur

监听文档失焦事件。

重要

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

语法
表达式.Sub.Window_Blur = Function
表达式：文档类型应用对象

示例

async function example() {
  await instance.ready();

  const app = instance.Application;

  //监听文档失焦事件
  app.Sub.Window_Blur = () => {
    console.log('文档失焦');
  };
}

Sub.Window_Focus

监听文档聚焦事件。

重要

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

语法
表达式.Sub.Window_Focus = Function
表达式：文档类型应用对象

示例

async function example() {
  await instance.ready();

  const app = instance.Application;

  //监听文档聚焦事件
  app.Sub.Window_Focus = () => {
    console.log('文档聚焦');
  };
}

Sub.User_Join

监听文档在线协作用户加入事件。

语法
表达式.Sub.User_Join = Function
表达式：文档类型应用对象

示例

async function example() {
  await instance.ready();

  const app = instance.Application;

  //监听协作用户加入事件
  app.Sub.User_Join = (e) => {
    console.log('协作用户加入：', e);
  };
}

Sub.User_Quit

监听文档在线协作用户退出事件。

语法
表达式.Sub.User_Quit = Function
表达式：文档类型应用对象

示例

async function example() {
  await instance.ready();

  const app = instance.Application;

  //监听协作用户退出事件
  app.Sub.User_Join = (e) => {
    console.log('协作用户退出：', e);
  };
}

Sub.Version_Change

监听文档版本改变事件。

语法
表达式.Sub.Version_Change = Function
表达式：文档类型应用对象

示例

async function example() {
  await instance.ready();

  const app = instance.Application;

  //监听文档版本改变事件
  app.Sub.Version_Change = (e) => {
    console.log('文档版本改变：', e);
  };
}

Sub.CollapseHeader

监听折叠工具栏操作

语法
表达式.Sub.CollapseHeader = Function
表达式：文档类型应用对象
返回值
属性
数据类型
说明
type
Boolean
折叠为true，展开为false

示例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 获取折叠工具栏回调事件
  app.Sub.CollapseHeader = (e) => {
    console.log("折叠或展开：", e.type);
  }
}

属性	数据类型	描述
copyId	String	剪切板ID。
isRestoreFocus	Boolean	是否复原焦点。
text	String	复制的内容。

属性	数据类型	说明
type	Boolean	折叠为true，展开为false