XL: Macro to Determine If a Button is on a Toolbar

ID: Q154904

The information in this article applies to:

• Microsoft Excel for Windows, versions 5.0, 5.0c
• Microsoft Excel for the Macintosh, versions 5.0, 5.0a
• Microsoft Excel for Windows 95, versions 7.0, 7.0a

SUMMARY

In Microsoft Excel, you can use a Microsoft Visual Basic for Applications macro to determine whether a button was added to a specific toolbar. Because there is no built-in function or property that tests for an existing button, you must use a For Each...Next loop in conjunction with an If statement to determine whether a button is on a specific toolbar.

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/

1. Insert a module sheet into a new workbook.

2. On the module sheet, type the following code:

      Sub check_button()
         ' Loop through all the toolbar buttons on the Standard toolbar.
         For Each x In Toolbars("standard").ToolbarButtons

            ' Check each toolbar button to see if it is the "Set Print 
            ' Area" toolbar button.
            If x.Name = "Set Print Area" Then

               ' Display a message box if the "Set Print Area" button is 
               ' found.
               MsgBox x.Name

            End If
         Next
      End Sub

If you added the "Set Print Area" button to the Standard toolbar, a message box displaying "Set Print Area" (without quotation marks) appears. If you did not add the "Set Print Area" button to the Standard toolbar, no message box appears.

NOTE: If you added a button from the Custom category in the Customize dialog box, the toolbar button will be called "Custom" (without quotation marks). To change the name of the button, please see the following articles in the Microsoft Knowledge Base:

   ARTICLE-ID: Q112632
   TITLE     : XL: Setting Status Bar Text and ToolTips for Toolbar Buttons

   ARTICLE-ID: Q126895
   TITLE     : Macro to Change the ToolTip Name for Custom Toolbar

REFERENCES

For more information about Customizing Toolbars in Microsoft Excel version 7.0, click Answer Wizard on the Help menu and type:

   how to customize toolbars

   toolbars, customizing

Keywords          : kbcode PgmHowto 
Version           : WINDOWS:5.0,5.0c,7.0,7.0a; MACINTOSH:5.0,5.0a
Platform          : MACINTOSH WINDOWS
Issue type        : kbhowto

Last Reviewed: May 18, 1999