ADD.COMMAND

Macro Sheets Only

Adds a command to a menu. ADD.COMMAND returns the position number on the menu of the added command. Use ADD.COMMAND to add one or more custom menu commands to a menu on a built-in or custom menu bar. You can also use ADD.COMMAND to restore a deleted built-in command to its original menu.

Syntax

ADD.COMMAND(bar_num, menu, command_ref, position1, position2)

Bar_num is the number corresponding to a menu bar or a type of shortcut menu to which you want to add a command.

• Bar_num can be the ID number of a built-in or custom menu bar. The ID number of a custom menu bar is the number returned by the ADD.BAR function.
• Bar_num can also refer to a type of shortcut menu; use menu to identify the specific shortcut menu.

The ID numbers of the built-in menu bars and the types of shortcut menus are listed in the following tables. Short menus are abbreviated versions of the normal Microsoft Excel menus. To turn on short menus, use the SHORT.MENUS function.

Bar_num Built-in menu bar

1 Worksheet and macro sheet (Microsoft Excel 4.0 or later)

2 Chart (Microsoft Excel 4.0 or later)

3 Null (the menu displayed when no workbooks are open)

4 Info

5 Worksheet and macro sheet (short menus, Microsoft Excel 3.0 and earlier)

6 Chart (short menus, Microsoft Excel 3.0 and earlier)

7 Cell, toolbar, and workbook (shortcut menus)

8 Object (shortcut menus)

9 Chart (Microsoft Excel 4.0 or later shortcut menus)

10 Worksheet and Macro sheet

11 Chart

12 Visual Basic

Menu is the menu to which you want the new command added.

• Menu can be either the name of a menu as text or the number of a menu.
• If bar_num is 1 through 6, menus are numbered starting with 1 from the left of the menu bar.
• If bar_num is 7, 8, or 9, menu refers to a built-in shortcut menu. The combination of bar_num and menu determines which shortcut menu to modify, as shown in the following table.

Note Any commands that you add to the toolbar buttons, watch pane, immediate pane or debug code pane shortcut menus will be dimmed.

Command_ref is an array or a reference to an area on the macro sheet that describes the new command or commands.

• Command_ref must be at least two columns wide. The first column specifies command names; the second specifies macro names. Optional columns can be specified for shortcut keys (in Microsoft Excel for the Macintosh), status bar messages, and custom Help topics, in that order.
• Command_ref is similar to menu_ref in ADD.MENU. For more information about command_ref, see the description of menu_ref in ADD.MENU.
• Command_ref can be the name, as text, of a previously deleted built-in command that you want to restore. You can also use the value returned by the DELETE.COMMAND formula that deleted the command.

Position1 specifies the placement of the new command.

• Use a hyphen (-) to represent a line separating commands on a menu. If you want to place a command before the second separator on a menu, use two hyphens (--), three hyphens for the third separator, and so on.
• Position1 can be a number indicating the position of the command on the menu. Commands are numbered from the top of the menu starting with 1.
• Position1 can be the name of an existing command, as text, above which you want to add the new command.
• If position1 is omitted, the command is added to the bottom of the menu.
• For the toolbar shortcut menu (bar_num 7, menu 1) and the shortcut menu for workbook paging icons in Microsoft Excel version 4.0(bar_num 7, menu 3), you cannot add commands to the middle of the toolbar name list or the middle of the workbook contents list.

Position2 specifies the placement of the new command on a submenu.

• Position2 can be a number indicating the position of the command on the submenu. Commands are numbered from the top of the menu starting with 1.
• Position2 can be the name of an existing command, as text, above which you want to add the new command.
• If position2 is omitted, the command is added to the main menu, not the submenu.
• To add a command to the bottom of a submenu, use 0 for position2.

Tip In general, use menu and command names rather than numbers for arguments. The numbers assigned to menus and commands change as you add and delete menus and commands. Using names ensures that your menu and command macro functions always refer to the correct items.

Example

The following macro formula adds the command described in cells G16:J16 to the bottom of the worksheet cells shortcut menu:

ADD.COMMAND(7, 4, G16:J16)

Related Functions

ADD.BAR Adds a menu bar

ADD.MENU Adds a menu to a menu bar

ADD.TOOL Adds one or more buttons to a toolbar

ADD.TOOLBAR Creates a toolbar with the specified tools

DELETE.COMMAND Deletes a command from a menu

ENABLE.COMMAND Enables or disables a menu or custom command

GET.TOOLBAR Retrieves information about a toolbar

RENAME.COMMAND Changes the name of a command or menu

List of Customizing Functions