Events.CommandBarEvents[Object] Property

Definition

Gets an object providing events fired when the supplied CommandBarControl object is clicked.

C++
public:
 property System::Object ^ CommandBarEvents[System::Object ^] { System::Object ^ get(System::Object ^ CommandBarControl); };
C++
public:
 property EnvDTE::CommandBarEvents ^ CommandBarEvents[System::Object ^] { EnvDTE::CommandBarEvents ^ get(System::Object ^ CommandBarControl); };

Parameters

CommandBarControl
Object

Required. The CommandBar control that causes the event to fire.

Property Value

A CommandBarEvents object.

Attributes

Remarks

The CommandBarEvents[] property is used to connect an event with a click of a Microsoft.VisualStudio.CommandBars.CommandBarControl object, or to connect to the Click event of any member of the Microsoft.VisualStudio.CommandBars.CommandBarControls collection.

You must set the OnAction property to some string value. You can set this value after the CommandBarEvents[] property is called, and can reset it to a blank string, which disconnects the event. If you create a control without setting the OnAction property to a valid string value, then no event is raised on the event object returned by the CommandBarEvents[] property.

Applies to

Product Versions
Visual Studio SDK 2015, 2017, 2019, 2022