XL97: Sample Macros to Return ID for a CommandBar Control

ID: Q162814

The information in this article applies to:

• Microsoft Excel 97 for Windows

SUMMARY

The Id property for the CommandBar object uses a unique number for each built-in menu bar, shortcut menu bar, submenu, menu item, or toolbar. The Id is often required when you reference a control on a command bar. The Visual Basic for Applications macro examples in this article return the Id for various Commandbar controls.

For additional information, please see the following article in the Microsoft Knowledge Base:

   ARTICLE-ID: XL97: List of ID Numbers for Built-In Command Bar Controls
   TITLE     : Q159466

MORE INFORMATION

Microsoft provides programming examples for illustration only, without warranty either expressed or implied, including, but not limited to, the implied warranties of merchantability and/or fitness for a particular purpose. This article assumes that you are familiar with the programming language being demonstrated and the tools used to create and debug procedures. Microsoft support professionals can help explain the functionality of a particular procedure, but they will not modify these examples to provide added functionality or construct procedures to meet your specific needs. If you have limited programming experience, you may want to contact the Microsoft fee-based consulting line at (800) 936-5200. For more information about the support options available from Microsoft, please see the following page on the World Wide Web:

   http://www.microsoft.com/support/supportnet/refguide/ 

Menu on a Menu Bar

The following macro example returns the Id for the Tools menu of the built- in Chart menu bar:

   Sub File_Id

      Dim x as Object
      set x = CommandBars("Chart Menu Bar").Controls("Tools")
      MsgBox x.Caption & Chr(13) & x.Id

   End Sub

Menu Command on a Menu

The following macro example returns the Id for the Exit command on the File menu of the built-in Worksheet menu bar:

   Sub FileExit_Id()

      Dim x as Object
      set x = CommandBars("Worksheet Menu Bar").Controls("File") _
      .Controls("Exit")
      MsgBox x.Caption & Chr(13) & x.Id

   End Sub

Command on a SubMenu of a ShortCut Menu

The following macro example returns the Id for the Calculated Item command on the Formulas submenu of the PivotTable shortcut menu bar:

   Sub SubMenu_Command_Id()

      Dim x as Object
      set x = CommandBars("PivotTable Context Menu").Controls("Formulas") _
      .Controls("Calculated Item...")
      MsgBox x.Caption & Chr(13) & x.Id

   End Sub

   Sub GetAll_Submenu_Ids()

      Dim ctrl as Object
      For Each ctrl in CommandBars("PivotTable Context Menu") _
      .Controls("Formulas").Controls
         MsgBox ctrl.Caption & Chr(13) & ctrl.Id
      Next ctrl

   End Sub

REFERENCES

For more information about programmatically customizing command bars, in the Visual Basic Editor, click the Office Assistant, type "Customizing menus," click Search, and then click to view "Overview of Command Bars."

NOTE: If the Assistant is hidden, click the Office Assistant button on the Standard toolbar. If Microsoft Visual Basic Help is not installed on your computer, please see the following article in the Microsoft Knowledge Base:

   ARTICLE-ID: Q120802
   TITLE     : Office: How to Add/Remove a Single Office
               Program or Component

Keywords          : kbprg kbdta KbVBA kbhowto 
Platform          : WINDOWS

Last Reviewed: May 26, 1999