Skip to main content

Application

Application​

属性​

Selection​

JSSDK: 1.9.4 Selection对象（表示文档中的当前所选区域）

语法

Application.Selection

返回值

Selection对象

示例

function example() {
  const Selection = Application.Selection;
}

supportedEvents​

支持的事件

语法

Application.supportedEvents

返回值

string[]

示例

function example() {
  const supportedEvents = Application.supportedEvents;
}

events​

监听的事件

语法

Application.events

返回值

string[]

示例

function example() {
  const events = Application.events;
}

docType​

文档类型

语法

Application.docType

返回值

string

示例

function example() {
  const evedocTypents = Application.docType;
}

方法​

addListener​

监听事件

setUIState​

JSSDK: 1.9.3、zOffice V8.0 FP3 支持

设置 api 调用时的默认文档状态，对所有 api 有效

语法

Application.setUIState(cursorContext)

参数

属性数据类型必填说明
cursorContextobject是文档光标状态

cursorContext 结构 | 属性 | 数据类型 | 必填 | 说明 | | focus | boolean | 否 | 是否聚焦到文档，默认true | | scroll | boolean | 否 | 是否滚动到目标位置，默认true |

返回值

Promise<boolean>

示例

async function example1() {
  const success = await Application.setUIState({ cursorContext: { focus: false, scroll: true }});

  const bookmark = await Application.ActiveDocument.Bookmarks.item('bm1');
  await bookmark.focus(); // 不聚焦到文档，仅视图滚动到书签位置，并选中书签区域
}

async function example2() {
  const success = await Application.setUIState({ cursorContext: { focus: false, scroll: false }});

  const bookmark = await Application.ActiveDocument.Bookmarks.item('bm1');
  await bookmark.setText('zOffice'); // 不聚焦到文档，不滚动到书签位置，仅设置书签区域内容
}

语法

removeListener​

移除事件监听

ready​

JSSDK: 1.2.3、zOffice2022.2 FP3 支持

调用高级 API 之前，等待文档加载完成，只需调用一次

语法

Application.ready()

返回值

Promise<boolean>

示例

async function example() {
  await Application.ready();
}

updateParams4thirdparty​

三方集成场景更新服务端的一些相关值

语法

Application.updateParams4thirdparty(params)

参数

属性数据类型必填说明
paramsstring是多个值以分号相隔

返回值

Promise<boolean>

示例

async function example() {
  const params = "3rd-party-token=xxx;id=demo-docx-123;x-webhook-header=xxx;";
  const success = await Application.updateParams4thirdparty(params);
  if(success){
    console.log('设置成功')
  }
}
Last updated on