CommandBar的方法和属性_智能媒体管理(IMM)-阿里云帮助中心

本文介绍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);
}

CommandBars(CommandBarId).Search()

通过Search()方法，您可以搜索指定内容。如下介绍如何根据搜索的文本，调用FloatQuickHelp（右下角浮动帮助按钮）对指定的内容进行搜索。

语法
表达式.CommandBars(CommandBarId).Search(Text)
表达式：文档类型应用对象
参数
属性
数据类型
是否必填
描述
Text
String
是
搜索的关键字。
返回值
返回的类型为Array.<Object>，返回的内容有以下2种情况：
- 普通的功能按钮
  属性
  数据类型
  描述
  iconClassName
  String
  图标的类名。
  text
  String
  按钮文本。
  shortcut
  String
  快捷键。
- 对应的文档链接
  属性
  数据类型
  描述
  content
  String
  搜索结果。
  url
  String
  跳转链接。

示例

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  //获取页面定制对象FloatQuickHelp
  const floatQuickHelp = await app.CommandBars('FloatQuickHelp');

  //通过FloatQuickHelp搜索“打印”相关信息
  const data = await floatQuickHelp.Search('打印');
  console.log(data);
}

属性

CommandBars(CommandBarId).Enabled

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

效果演示
- 禁用按钮（置灰）
- 启用按钮

语法
表达式.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);
}

属性	数据类型	是否必填	描述
Text	String	是	搜索的关键字。

属性	数据类型	描述
iconClassName	String	图标的类名。
text	String	按钮文本。
shortcut	String	快捷键。