Edit

Events (Visual Basic Add-In Model)

  • Article

Click event

Occurs when the OnAction property of a corresponding command bar control is set.

Syntax

Subobject_Click (ByVal ctrl As Object, ByRef handled As Boolean, ByRef canceldefault As Boolean)

The Click event syntax has these named arguments:

Part Description
ctrl Required; Object. Specifies the object that is the source of the Click event.
handled Required; Boolean. If True, other add-ins should handle the event. If False, the action of the command bar item has not been handled.
canceldefault Required; Boolean. If True, default behavior is performed unless canceled by a downstream add-in. If False, default behavior is not performed unless restored by a downstream add-in.

Remarks

The Click event is specific to the CommandBarEvents object. Use a variable declared by using the WithEvents keyword to receive the Click event for a CommandBar control. This variable should be set to the return value of the CommandBarEvents property of the Events object.

The CommandBarEvents property takes the CommandBar control as an argument. When the CommandBar control is clicked (for the variable you declared by using the WithEvents keyword), the code is executed.

ItemAdded event

Occurs after a reference is added.

Syntax

Subobject_ItemAdded (ByVal item As Reference)

The required item argument specifies the item that was added.

Remarks

The ItemAdded event occurs when a Reference is added to the References collection.

ItemRemoved event

Occurs after a Reference is removed from a project.

Syntax

Subobject_ItemRemoved (ByVal item As Reference)

The required item argument specifies the Reference that was removed.

See also

Support and feedback

Have questions or feedback about Office VBA or this documentation? Please see Office VBA support and feedback for guidance about the ways you can receive support and provide feedback.