Events2.CommandBarEvents[Object] Property

Reference

Definition

Namespace:: EnvDTE80

Assembly:: EnvDTE80.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

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

[System.Runtime.InteropServices.DispId(205)]
public object CommandBarEvents[object CommandBarControl] { [System.Runtime.InteropServices.DispId(205)] get; }

[<System.Runtime.InteropServices.DispId(205)>]
[<get: System.Runtime.InteropServices.DispId(205)>]
member this.CommandBarEvents(obj) : obj

Public ReadOnly Property CommandBarEvents(CommandBarControl As Object) As Object

Parameters

CommandBarControl: Object

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

Property Value

Object

A CommandBarEvents object.

Implements

CommandBarEvents[Object]

Attributes: DispIdAttribute

Remarks

Use the CommandBarEvents[] property 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. It can set this value after the CommandBarEvents[] property is called, and it can reset it to a blank string, which disconnects the event. If you create a control and fail to set the OnAction property to a valid string value, then no event is raised on the event object returned by the CommandBarEvents[] property.

Applies to