CommandBarButton.Tag Property

  • Article
Office Developer Reference

Gets or sets information about the CommandBarButton control, such as data that can be used as an argument in procedures, or information that identifies the control. Read/write.

Aa432923.vs_note(en-us,office.12).gif  Note
The use of CommandBars in some Microsoft Office applications has been superseded by the new Ribbon user interface. For more information, search help for the keyword "Ribbon."

Syntax

expression.Tag

expression   A variable that represents a CommandBarButton object.

Return Value
String

Example

To avoid duplicate calls of the same class when tiggered with events, define the Tag property unique to the events. The following example demonstrates this concept with two modules.

Visual Basic for Applications 
  Public WithEvents oBtn As CommandBarButton

Private Sub oBtn_click(ByVal ctrl As Office.CommandBarButton, CancelDefault As Boolean)
MsgBox "Clicked " & ctrl.Caption


End Sub


Dim oBtns As New Collection


Sub Use_Tag()


Dim oEvt As CBtnEvent
Set oBtns = Nothing

For i = 1 To 5
    Set oEvt = New CBtnEvent
    Set oEvt.oBtn = Application.CommandBars("Worksheet Menu Bar").Controls.Add(msoControlButton)
    With oEvt.oBtn
        .Caption = "Btn" & i
        .Style = msoButtonCaption
        .Tag = "Hello" & i
    End With
    oBtns.Add oEvt
Next
 



End Sub

This example sets the tag for the button on the custom command bar to "Spelling Button" and displays the tag in a message box.

Visual Basic for Applications 
  CommandBars("Custom").Controls(1).Tag = "Spelling Button"
MsgBox (CommandBars("Custom").Controls(1).Tag)

See Also