WebOffice 开放平台主题
公共处理函数(Public)
该对象内封装了一些常用的公共处理函数，方便您进行开发和调试。
属性列表
| 属性 | 说明 |
|---|---|
表达式：实例化的 Public 对象 |
方法列表
| 方法 | 说明 |
|---|---|
派发第三方弹窗操作事件 | |
封装 window.open，并加入跳转链接安全检查逻辑 | |
恢复历史版本 | |
发送全局广播 |
KeyBoardHeight
【移动端】获取和设置键盘高度
注：设置高度为 逻辑像素，设置前请先处理物理像素和逻辑像素的转换
语法
表达式.KeyBoardHeight
表达式：实例化的 Public 对象
示例
js
//@file=base.docx
async function example() {
await instance.ready()
const app = instance.Application
// 公共处理对象
const Public = await app.Public
// 【移动端】获取键盘高度
const height = await Public.KeyBoardHeight
// 设置高度
Public.KeyBoardHeight = 48
}
DispatchModelVisible()
派发第三方弹窗操作事件
语法
表达式.DispatchModelVisible({ Visible })
表达式：实例化的 Public 对象
参数
| 属性 | 数据类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
Visible | boolean | false | 否 | 可视化状态 |
返回值
返回对应的 Public 对象。
示例
js
//@file=base.docx
async function example() {
await instance.ready()
const app = instance.Application
// 公共处理对象
const Public = await app.Public
// 派发第三方弹窗操作事件
const pane = await Public.DispatchModelVisible(true)
}
OpenLink()
封装 window.open，并加入跳转链接安全检查逻辑
语法
表达式.OpenLink()
表达式：实例化的 Public 对象
参数
参数同 window.open()，参考链接。
示例
js
//@file=base.docx
async function example() {
await instance.ready()
const app = instance.Application
await app.Public.OpenLink('https://www.kdocs.cn')
await app.Public.OpenLink('https://www.baidu.com')
}
PreviewRestore()
恢复历史版本
语法
表达式.PreviewRestore({ Version, Reversion, })
表达式：实例化的 Public 对象
参数
| 属性 | 数据类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
Version | number | 是 | 按历史版本恢复 | |
Revision | number | 否 | 按协作纪录恢复 | |
HistoryId | string | 否 | 历史版本 ID |
返回值
返回对应的 Public 对象。
示例
js
//@file=base.docx
async function example() {
await instance.ready()
const app = instance.Application
// 公共处理对象
const Public = await app.Public
// 恢复历史版本
const pane = await Public.PreviewRestore({
Version: 535,
HistoryId: 'test'
})
}
SendBroadcast()
发送全局广播
语法
表达式.SendBroadcast({ Data, Id })
表达式：实例化的 Public 对象
参数
| 属性 | 数据类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
Data | Object | 是 | 信息 | |
Id | Boolean | 否 | 指定接收信息的用户 ID |
返回值
返回对应的 Public 对象。
示例
js
//@file=base.docx
async function example() {
await instance.ready()
const app = instance.Application
// 公共处理对象
const Public = await app.Public
// 发送全局广播
const result = await Public.SendBroadcast({
Data: { message: '测试' }
})
}