CommandBar

更新时间:
复制 MD 格式

本文介绍CommandBar的方法和属性。

方法

CommandBars(CommandBarId).Execute()

通过Execute()方法,您可以控制组件的点击。如下以更多菜单按钮为例介绍如何在需要时控制按钮自行点击打开。

  • 效果演示

    • 单击后

  • 语法

    表达式.CommandBars(CommandBarId).Execute()

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取页面定制对象更多菜单
      const moreMenus = await app.CommandBars('MoreMenus');
    
      //3000 ms后触发具体事件
      setTimeout( async () => {
        //单击更多菜单
        await moreMenus.Execute();
      }, 3000);
    }

    自动打印

    如需打开文档后自动触发打印,可调用更多菜单中的打印按钮(CommandBarId 为 MenuPrintPreview),或调用工具栏中的打印按钮(CommandBarId 为 TabPrintPreview)。完整的 CommandBarId 列表参见可定制列表。

    调用前需在 GenerateWebofficeToken 接口中设置 WebofficePermission.Print 为 true,否则打印按钮处于禁用状态,Execute() 无法触发打印。

    async function autoPrint() {
      await instance.ready();
    
      const app = instance.Application;
    
      //方式一:通过更多菜单中的打印按钮触发
      const printBtn = await app.CommandBars('MenuPrintPreview');
      await printBtn.Execute();
    
      //方式二:通过工具栏打印按钮触发
      // const printBtn = await app.CommandBars('TabPrintPreview');
      // await printBtn.Execute();
    }

属性

CommandBars(CommandBarId).Enabled

通过设置Enabled属性,您可以控制组件的禁用或启用。如下以更多菜单按钮为例介绍如何禁用组件。

  • 效果演示

    • 禁用按钮(置灰):工具栏中的开始按钮及格式按钮(B、I、U、S)、字体下拉框、字号下拉框等组件均处于禁用状态,无法点击操作。

    • 启用按钮示例为工具栏左上角的视图切换按钮(三横线图标)。

  • 语法

    表达式.CommandBars(CommandBarId).Enabled

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

  • 示例

    async function example() {
      await instance.ready();
      const app = instance.Application;
      //获取页面定制对象:更多菜单
      const moreMenus = await app.CommandBars('MoreMenus');
      //控制更多菜单禁用
      moreMenus.Enabled = false;
      //获取更多菜单禁用状态
      const enabled = await moreMenus.Enabled;
      console.log(enabled);
    }

CommandBars(CommandBarId).Visible

通过设置Visible属性,您可以控制组件的显示或隐藏。如下以更多菜单按钮为例介绍如何隐藏组件。

  • 效果演示

    • 隐藏按钮隐藏

    • 显示按钮显示

  • 语法

    表达式.CommandBars(CommandBarId).Visible

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取页面定制对象:更多菜单
      const moreMenus = await app.CommandBars('MoreMenus');
    
      //控制更多菜单隐藏
      moreMenus.Visible = false;
    
      //获取更多菜单状态
      const visible = await moreMenus.Visible;
      console.log(visible);
    }