事件(Sub)

事件对象

属性列表

属性	说明
Clipboard_Copy	监听复制操作
User_Join	监听协作用户加入事件
User_Quit	监听协作用户退出事件
Version_Change	监听文档版本改变事件
Window_Blur	监听文档失焦事件
Window_Focus	监听文档聚焦事件
Worksheet_Activate	监听工作表的切换
Sub.Worksheet_ForceLandscape	监听强制横屏时通知
Worksheet_ScrollChange	监听用户自己的滚动画布行为
Worksheet_SelectionChange	监听选区改变事件

Clipboard_Copy

监听复制操作

语法

表达式.Sub.Clipboard_Copy = Function

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

返回值

属性	数据类型	说明
copyId	String	剪切板 id
isRestoreFocus	Boolean	undefined
text	String	复制的内容

示例

//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取剪切板回调事件
  app.Sub.Clipboard_Copy = e => {
    console.log(e)
  }
}

User_Join

监听协作用户加入事件

语法

表达式.Sub.User_Join = Function

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

示例

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  app.Sub.User_Join = e => {
    console.log('协作用户加入：', e)
  }
}

User_Quit

监听协作用户退出事件

语法

表达式.Sub.User_Quit = Function

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

示例

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  app.Sub.User_Quit = e => {
    console.log('协作用户退出：', e)
  }
}

Version_Change

监听文档版本改变事件

语法

表达式.Sub.Version_Change = Function

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

示例

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  app.Sub.Version_Change = e => {
    console.log('文档版本改变：', e)
  }
}

Window_Blur

仅支持 PC 端

监听文档失焦事件

语法

表达式.Sub.Window_Blur = Function

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

示例

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  app.Sub.Window_Blur = () => {
    console.log('文档失焦')
  }
}

Window_Focus

仅支持 PC 端

监听文档聚焦事件

语法

表达式.Sub.Window_Focus = Function

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

示例

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  app.Sub.Window_Focus = () => {
    console.log('文档聚焦')
  }
}

Worksheet_Activate

监听工作表的切换

语法

表达式.Sub.Worksheet_Activate = Function

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

示例

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 监听工作表的切换
  app.Sub.Worksheet_Activate = async () => {
    console.log('ActiveSheet：', await app.ActiveSheet.Name)
  }
}

Sub.Worksheet_ForceLandscape

监听强制横屏时通知

语法

表达式.Sub.Worksheet_ForceLandscape = Function

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

示例

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 监听强制横屏时通知
  app.Sub.Worksheet_ForceLandscape = e => {
    console.log('ForceLandscape', e)
  }
}

Worksheet_ScrollChange

监听用户自己的滚动画布行为

语法

表达式.Sub.Worksheet_ScrollChange = Function

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

示例

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 监听用户自己的滚动画布行为
  app.Sub.Worksheet_ScrollChange = () => {
    console.log('ScrollChange')
  }
}

Worksheet_SelectionChange

监听选区改变事件

语法

表达式.Sub.Worksheet_SelectionChange = Function

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

示例

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

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