CommandBarButton Interface

Represents the command bar button.

Namespace:  Microsoft.VisualStudio.CommandBars
Assembly:  Microsoft.VisualStudio.CommandBars (in Microsoft.VisualStudio.CommandBars.dll)

Syntax

'Declaration
<GuidAttribute("E11C7CE2-8641-4183-9458-309C6A201CDD")> _
Public Interface CommandBarButton _
    Inherits _CommandBarButton, _CommandBarButtonEvents_Event
[GuidAttribute("E11C7CE2-8641-4183-9458-309C6A201CDD")]
public interface CommandBarButton : _CommandBarButton, 
    _CommandBarButtonEvents_Event
[GuidAttribute(L"E11C7CE2-8641-4183-9458-309C6A201CDD")]
public interface class CommandBarButton : _CommandBarButton, 
    _CommandBarButtonEvents_Event
[<GuidAttribute("E11C7CE2-8641-4183-9458-309C6A201CDD")>]
type CommandBarButton =  
    interface 
        interface _CommandBarButton 
        interface _CommandBarButtonEvents_Event 
    end
public interface CommandBarButton extends _CommandBarButton, _CommandBarButtonEvents_Event

The CommandBarButton type exposes the following members.

Properties

  Name Description
Public property accChild Gets the child. This property is deprecated. (Inherited from _CommandBarButton.)
Public property accChildCount Gets the number of children. This property is deprecated. (Inherited from _CommandBarButton.)
Public property accDefaultAction Gets the default action. This property is deprecated. (Inherited from _CommandBarButton.)
Public property accDescription Gets the description. This property is deprecated. (Inherited from _CommandBarButton.)
Public property accFocus Gets the focus. This property is deprecated. (Inherited from _CommandBarButton.)
Public property accHelp Gets the help. This property is deprecated. (Inherited from _CommandBarButton.)
Public property accHelpTopic Gets the help topic. This property is deprecated. (Inherited from _CommandBarButton.)
Public property accKeyboardShortcut Gets the keyboard shortcut. This property is deprecated. (Inherited from _CommandBarButton.)
Public property accName Gets the name of the object. (Inherited from _CommandBarButton.)
Public property accParent Gets the parent. This property is deprecated. (Inherited from _CommandBarButton.)
Public property accRole Gets the role. This property is deprecated. (Inherited from _CommandBarButton.)
Public property accSelection Gets the selection. This property is deprecated. (Inherited from _CommandBarButton.)
Public property accState Gets the state. This property is deprecated. (Inherited from _CommandBarButton.)
Public property accValue Gets the value. This property is deprecated. (Inherited from _CommandBarButton.)
Public property Application Gets the DTE object. (Inherited from _CommandBarButton.)
Public property BeginGroup Determines whether this control is the first in its group. (Inherited from _CommandBarButton.)
Public property BuiltIn Determines whether this control is a custom control or a built-in control. (Inherited from _CommandBarButton.)
Public property BuiltInFace The built-in image. This property is deprecated. (Inherited from _CommandBarButton.)
Public property Caption Gets the caption of the control. (Inherited from _CommandBarButton.)
Public property Control Gets the control itself. (Inherited from _CommandBarButton.)
Public property Creator Gets the ID of the application. (Inherited from _CommandBarButton.)
Public property DescriptionText Always returns the empty string. (Inherited from _CommandBarButton.)
Public property Enabled Determines whether the control is enabled. (Inherited from _CommandBarButton.)
Public property FaceId This property is deprecated. (Inherited from _CommandBarButton.)
Public property Height Gets the height of the button. (Inherited from _CommandBarButton.)
Public property HelpContextId Gets the help context ID. Always returns 0. (Inherited from _CommandBarButton.)
Public property HelpFile Always returns the empty string. (Inherited from _CommandBarButton.)
Public property HyperlinkType Gets the hyperlink type. This property is deprecated. (Inherited from _CommandBarButton.)
Public property Id Gets the identifier of the button. (Inherited from _CommandBarButton.)
Public property Index Gets the index of this control in the set of controls on the command bar. (Inherited from _CommandBarButton.)
Public property InstanceId Gets the instance ID of this control. (Inherited from _CommandBarButton.)
Public property IsPriorityDropped Determines whether the priority has been lowered. Always returns false. (Inherited from _CommandBarButton.)
Public property Left Gets the left coordinates. This property is deprecated. (Inherited from _CommandBarButton.)
Public property Mask Gets the mask. This property is deprecated. (Inherited from _CommandBarButton.)
Public property OLEUsage Gets or sets the OLE usage. This property is deprecated. (Inherited from _CommandBarButton.)
Public property OnAction Gets or sets the OnAction string. (Inherited from _CommandBarButton.)
Public property Parameter Gets or sets the parameter that is used with the command. (Inherited from _CommandBarButton.)
Public property Parent Gets the parent command bar. (Inherited from _CommandBarButton.)
Public property Picture Gets or sets the icon that appears on the button. (Inherited from _CommandBarButton.)
Public property Priority Gets the priority. Always returns 1. (Inherited from _CommandBarButton.)
Public property ShortcutText Gets or sets the shortcut text. This property is deprecated. (Inherited from _CommandBarButton.)
Public property State Gets or sets the state. This property is deprecated. (Inherited from _CommandBarButton.)
Public property Style Gets or sets the button style. (Inherited from _CommandBarButton.)
Public property Tag Gets or sets the tag. Not used in Visual Studio. (Inherited from _CommandBarButton.)
Public property TooltipText Gets or sets the tooltip text. (Inherited from _CommandBarButton.)
Public property Top Gets the top. This property is deprecated. (Inherited from _CommandBarButton.)
Public property Type Gets the type of the control. (Inherited from _CommandBarButton.)
Public property Visible Determines whether this control is visible. (Inherited from _CommandBarButton.)
Public property Width Gets or sets the width of the control. (Inherited from _CommandBarButton.)

Top

Methods

  Name Description
Public method accDoDefaultAction Performs the default action. This method is deprecated. (Inherited from _CommandBarButton.)
Public method accHitTest Gets the object at the specified coordinates. This method is deprecated. (Inherited from _CommandBarButton.)
Public method accLocation Gets the location of the control. This method is deprecated. (Inherited from _CommandBarButton.)
Public method accNavigate Navigates to another object. This method is deprecated. (Inherited from _CommandBarButton.)
Public method accSelect Selects an object. This method is deprecated. (Inherited from _CommandBarButton.)
Public method add_Click Adds the click event handler. (Inherited from _CommandBarButtonEvents_Event.)
Public method Copy Copies this control to the specified position on the specified command bar. (Inherited from _CommandBarButton.)
Public method CopyFace Copies the image. This method is deprecated. (Inherited from _CommandBarButton.)
Public method Delete Removes this control from the collection. (Inherited from _CommandBarButton.)
Public method Execute Performs the action of this control. (Inherited from _CommandBarButton.)
Public method Move Moves this control to the specified command bar at the specified position. (Inherited from _CommandBarButton.)
Public method PasteFace Pastes the image. This method is deprecated. (Inherited from _CommandBarButton.)
Public method remove_Click Removes the click event handler. (Inherited from _CommandBarButtonEvents_Event.)
Public method Reserved1 Reserved. (Inherited from _CommandBarButton.)
Public method Reserved2 Reserved. (Inherited from _CommandBarButton.)
Public method Reserved3 Reserved. (Inherited from _CommandBarButton.)
Public method Reserved4 Reserved. (Inherited from _CommandBarButton.)
Public method Reserved5 Reserved. (Inherited from _CommandBarButton.)
Public method Reserved6 Reserved. (Inherited from _CommandBarButton.)
Public method Reserved7 Reserved. (Inherited from _CommandBarButton.)
Public method Reset Resets the button. (Inherited from _CommandBarButton.)
Public method SetFocus Sets the focus. (Inherited from _CommandBarButton.)

Top

Events

  Name Description
Public event Click The click event. Microsoft Internal Use Only. (Inherited from _CommandBarButtonEvents_Event.)

Top

Remarks

A _CommandBarButton implements only CommandBarControl, which defines no events. A CommandBarButton implements both _CommandBarButton and _CommandBarButtonEvents_Event. CommandBarButtonClass implements all three interfaces.

See Also

Reference

Microsoft.VisualStudio.CommandBars Namespace