概述 | 软件包 | 类 | 树 | 索引 | 帮助

上一个类 下一个类 | 框架 无框架
摘要： 嵌套 | 字段 | 构造函数 | 方法 | 详细信息： 字段 | 构造函数 | 方法

## application.commandbars
类 CommandBar

    java.lang.Object
      application.commandbars.CommandBar

    public final class CommandBar

extends java.lang.Object

该类定义了工具条菜单方面的方法。

字段摘要
`static int` | `MENU` CommandBar的类型：菜单。
`static int` | `TOOLBAR` CommandBar的类型：工具条。

方法摘要
`void` | `addCustomBar(int index, java.lang.Object menuData)` 添加自定义工具条。
`void` | `addItemByID(int index, int item_ID)` 添加工具条或菜单的内容.
`void` | `addItemByID(int productType, int index, boolean beforeFlag, int item_ID)` 添加工具条或菜单的内容.
`void` | `deleteCustomItemByID(int customItem_ID)` 删除自定义工具条或菜单的内容.
`void` | `deleteCustomItemByID(int productType, int customItem_ID)` 删除自定义工具条或菜单的内容。
`void` | `deleteItemByID(int item_ID)` 删除工具条或菜单的内容，所删除的内容只限于永中集成Office中给出ID的已有菜单项或工具条项。
`void` | `deleteItemByID(int productType, int item_ID)` 删除工具条或菜单的内容，所删除的内容只限于永中集成Office中给出ID的已有菜单项或工具条项。
`char` | `getAccelerator()` 获得快捷键，该方法适用于菜单。
`CommandBarControls` | `getControls()` 返回菜单、工具栏控件的管理器。
`int` | `getID()` 获得CommandBar对象的ID属性
`java.lang.String` | `getName()` 获得工具条或菜单的名称。
`int` | `getType()` 返回CommandBar的类型，取以下常量值： CommandBar.MENU 菜单 CommandBar.TOOLBAR 工具条。
`boolean` | `isEnabled()` 返回菜单栏、工具栏是否可以使用。
`boolean` | `isFloating()` 返回工具栏是否入坞。
`boolean` | `isVisible()` 返回是否隐藏。
`void` | `setEnabled(boolean enabled)` 设置菜单栏、工具栏是否可以使用。
`void` | `setFloating(boolean b)` 设置工具栏入坞，目前只能支持false，即工具栏入坞。
`void` | `setVisible(boolean visible)` 设置工具栏是否隐藏。

从类 java.lang.Object 继承的方法
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

字段详细信息

### MENU

    public static final int MENU

  CommandBar的类型：菜单。

### TOOLBAR

    public static final int TOOLBAR

  CommandBar的类型：工具条。

方法详细信息

### addCustomBar

    public void addCustomBar(int index,
                             java.lang.Object menuData)

  添加自定义工具条。

  参数：
    `index` - 想要添加的位置
    `menuData` - 自定义工具条对象实例

    例子:

         CommandBars bars = Application.getCommandBars();
         CommandBar bar = bars.addMenu(2, 'C', "Customized Menu");
         bar.addCustomBar(0, Object);

### addItemByID

    public void addItemByID(int index,
                            int item_ID)

  添加工具条或菜单的内容.

  参数：
    `index` - 想要添加的位置
    `item_ID` - 添加的内容的ID

    例子:

         CommandBar bar = Application.getCommandBars().getCommandBarByID(CommandBar.MENU, MenuIDConstants.FILE);
         bar.addItemByID(MenuIDConstants.FILE_CLOSE, MenuIDConstants.EDIT_COPY);

### addItemByID

    public void addItemByID(int productType,
                            int index,
                            boolean beforeFlag,
                            int item_ID)

  添加工具条或菜单的内容.

  参数：
    `productType` - 产品类型
    `index` - 想要添加的位置
    `beforeFlag` - 如为true 在index前添加 如为false 在index后面添加
    `item_ID` - 添加的内容的ID

    例子:

         CommandBar bar = Application.getCommandBars().getCommandBarByID(CommandBar.MENU, MenuIDConstants.FILE);
         bar.addItemByID(GlobalConstants.WORDPROCESSOR,MenuIDConstants.FILE_CLOSE, true, MenuIDConstants.EDIT_COPY);

### deleteCustomItemByID

    public void deleteCustomItemByID(int customItem_ID)

  删除自定义工具条或菜单的内容.

  参数：
    `customItem_ID` - 删除的内容的自定义ID

    例子:

         因为此例子涉及自定义的工具条或菜单的内容,为了使结果可见,采用两个宏模块.
         先打开文字处理,再运行下面的宏:
         CommandBar bar = Application.getCommandBars().getCommandBarByID(CommandBar.MENU, MenuIDConstants.FILE);
         bar.addItemByID(MenuIDConstants.FILE_CLOSE, MenuIDConstants.EDIT_COPY);
         此宏模块在"文件"菜单条添加"复制"菜单项,然后运行下面的模块可以删除该菜单项.
         CommandBar bar = Application.getCommandBars().getCommandBarByID(CommandBar.MENU, MenuIDConstants.FILE);
         bar.deleteCustomItemByID(MenuIDConstants.EDIT_COPY);

### deleteCustomItemByID

    public void deleteCustomItemByID(int productType,
                                     int customItem_ID)

  删除自定义工具条或菜单的内容。

  参数：
    `productType` - 产品类型
    `customItem_ID` - 删除的内容的ID

    例子:

         因为此例子涉及自定义的工具条或菜单的内容,为了使结果可见,采用两个宏模块.先打开文字处理,再运行宏:
         CommandBar bar = Application.getCommandBars().getCommandBarByID(CommandBar.MENU, MenuIDConstants.FILE);
         bar.addItemByID(MenuIDConstants.FILE_CLOSE, MenuIDConstants.EDIT_COPY);
         此宏在"文件"菜单条添加"复制"菜单项,然后运行下面的模块可以删除该菜单项.
         CommandBar bar = Application.getCommandBars().getCommandBarByID(CommandBar.MENU, MenuIDConstants.FILE);
         bar.deleteCustomItemByID(GlobalConstants.WORDPROCESSOR, MenuIDConstants.EDIT_COPY);

### deleteItemByID

    public void deleteItemByID(int item_ID)

  删除工具条或菜单的内容，所删除的内容只限于永中集成Office中给出ID的已有菜单项或工具条项。

  参数：
    `item_ID` - 删除的内容的ID

    例子:

         CommandBar bar = Application.getCommandBars().getCommandBarByID(CommandBar.MENU, MenuIDConstants.FILE);
         bar.deleteItemByID(MenuIDConstants.FILE_CLOSE);

### deleteItemByID

    public void deleteItemByID(int productType,
                               int item_ID)

  删除工具条或菜单的内容，所删除的内容只限于永中集成Office中给出ID的已有菜单项或工具条项。

  参数：
    `productType` - 产品类型
    `item_ID` - 删除的内容的ID

    例子:

         CommandBar bar = Application.getCommandBars().getCommandBarByID(CommandBar.MENU, MenuIDConstants.FILE);
         bar.deleteItemByID(GlobalConstants.WORDPROCESSOR,MenuIDConstants.FILE_CLOSE);

### getAccelerator

    public char getAccelerator()

  获得快捷键，该方法适用于菜单。

  返回：
    快捷键

    例子:

         CommandBars bars = Application.getCommandBars();
         CommandBar bar = bars.addMenu(2, 'C', "Customized Menu");
         char accelerator = bar.getAccelerator();

### getControls

    public CommandBarControls getControls()

  返回菜单、工具栏控件的管理器。

  返回：
    控件管理器

    例子:

         //输出格式化工具栏上的控件总数
         CommandBars bars = Application.getCommandBars();
         CommandBar bar = bars.getCommandBar("formatting");
         CommandBarControls controls = bar.getControls();
         System.out.println(controls.getCount());

### getID

    public int getID()

  获得CommandBar对象的ID属性

  返回：
    工具条或菜单在永中集成Office的ID

    例子:

         CommandBars bars = Application.getCommandBars();
         CommandBar bar = bars.addMenu(2, 'C', "Customized Menu");
         int ID = bar.getID();

### getName

    public java.lang.String getName()

  获得工具条或菜单的名称。

  返回：
    工具条或菜单的名称。

    例子:

         CommandBars bars = Application.getCommandBars();
         CommandBar bar = bars.addMenu(2, 'C', "Customized Menu");
         String name = bar.getName();

### getType

    public int getType()

  返回CommandBar的类型，取以下常量值：

       CommandBar.MENU      菜单
       CommandBar.TOOLBAR   工具条。

  返回：
    CommandBar的类型

    例子:

         CommandBars bars = Application.getCommandBars();
         CommandBar bar = bars.addMenu(2, 'C', "Customized Menu");
         int type = bar.getType();

### isEnabled

    public boolean isEnabled()

  返回菜单栏、工具栏是否可以使用。

  返回：
    菜单栏、工具栏是否可以使用

    例子:

         //设置格式化工具栏无法使用。
         CommandBars bars = Application.getCommandBars();
         CommandBar bar = bars.getCommandBar(BarConstants.FORMATTING_INDEX);
         bar.setEnabled(false);
         System.out.println(bar.isEnabled());

### isFloating

    public boolean isFloating()

  返回工具栏是否入坞。

  返回：

    例子:

         //设置浮动的格式化工具栏入坞。
         CommandBars bars = Application.getCommandBars();
         CommandBar bar = bars.getCommandBar("formatting");
         bar.setFloating(false);
         System.out.println(bar.isFloating());

### isVisible

    public boolean isVisible()

  返回是否隐藏。如果是菜单，则总是返回true。

  返回：
    菜单栏、工具栏是否隐藏

    例子:

         //设置不显示格式化工具栏。
         CommandBars bars = Application.getCommandBars();
         CommandBar bar = bars.getCommandBar(BarConstants.FORMATTING_INDEX);
         bar.setVisible(false);
         System.out.println(bar.isVisible());

### setEnabled

    public void setEnabled(boolean enabled)

  设置菜单栏、工具栏是否可以使用。对于工具栏，如果设置为false，则此工具栏无法使用并隐藏，同时在有效命令栏列表中不再显示。

  参数：
    `enabled` - 菜单栏、工具栏是否可以使用

    例子:

         //设置格式化工具栏无法使用。
         CommandBars bars = Application.getCommandBars();
         CommandBar bar = bars.getCommandBar(BarConstants.FORMATTING_INDEX);
         bar.setEnabled(false);

### setFloating

    public void setFloating(boolean b)

  设置工具栏入坞，目前只能支持false，即工具栏入坞。对于菜单栏，调用此方法无任何效果。

  参数：
    `b` - 是否入坞

    例子:

         //设置浮动的格式化工具栏入坞。
         CommandBars bars = Application.getCommandBars();
         CommandBar bar = bars.getCommandBar("formatting");
         bar.setFloating(false);

### setVisible

    public void setVisible(boolean visible)

  设置工具栏是否隐藏。如果是菜单，则无任何效果。

  参数：
    `visible` - true为隐藏，false为显示。

    例子:

         //设置不显示格式化工具栏。
         CommandBars bars = Application.getCommandBars();
         CommandBar bar = bars.getCommandBar(BarConstants.FORMATTING_INDEX);
         bar.setVisible(false);

概述 | 软件包 | 类 | 树 | 索引 | 帮助

上一个类 下一个类 | 框架 无框架
摘要： 嵌套 | 字段 | 构造函数 | 方法 | 详细信息： 字段 | 构造函数 | 方法

版权所有 2001-2008 无锡永中科技有限公司