Public

Public

公共处理函数。

• 语法

  表达式.Public

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

• 示例

  //@file=base.docx
  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //公共处理对象
    const panes = await app.Public;
  }

方法

Public.SendBroadcast()

发送全局广播。

• 语法

  表达式.SendBroadcast({ Data, Id })

  表达式：实例化的Public对象

• 参数

  属性	数据类型	是否必填	描述
  Data	Object	是	信息。
  Id	Boolean	否	指定接收信息的用户ID。

• 返回值

  返回对应的Public对象。

• 示例

  //@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: '测试'}
    });
  }

Public.PreviewRestore()

恢复历史版本。

• 语法

  表达式.PreviewRestore({ Version, Reversion, })

  表达式：实例化的Public对象

• 参数

  属性	数据类型	是否必填	描述
  Version	number	是	按历史版本恢复。
  Revision	number	否	按协作纪录恢复。
  HistoryId	string	否	历史版本ID。

• 返回值

  返回对应的Public对象。

• 示例

  //@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'});
  }

Public.DispatchModelVisible()

派发第三方弹窗操作事件。

• 语法

  表达式.DispatchModelVisible({ Visible })

  表达式：实例化的Public对象

• 参数

  属性	数据类型	是否必填	描述
  Visible	boolean	否	可视化状态。默认值为false。

• 返回值

  返回对应的Public对象。

• 示例

  //@file=base.docx
  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //公共处理对象
    const Public = await app.Public;
  
    //派发第三方弹窗操作事件
    const pane = await Public.DispatchModelVisible(true);
  }

Public.OpenLink()

封装window.open并加入跳转链接安全检查逻辑。参数同window.open()。

• 语法

  表达式.OpenLink()

  表达式：实例化的Public对象

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    await app.Public.OpenLink('https://www.aliyun.com')
  }

属性

Public.KeyBoardHeight

移动端获取和设置键盘高度。

• 语法

  表达式.KeyBoardHeight

  表达式：实例化的Public对象

• 示例

  //@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;
  }