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
The CommandBarButton type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
accChild[Object] | Gets the child. This property is deprecated. (Inherited from _CommandBarButton.) |
|
accChildCount | Gets the number of children. This property is deprecated. (Inherited from _CommandBarButton.) |
|
accDefaultAction[Object] | Gets the default action. This property is deprecated. (Inherited from _CommandBarButton.) |
|
accDescription[Object] | Gets the description. This property is deprecated. (Inherited from _CommandBarButton.) |
|
accFocus | Gets the focus. This property is deprecated. (Inherited from _CommandBarButton.) |
|
accHelp[Object] | Gets the help. This property is deprecated. (Inherited from _CommandBarButton.) |
|
accHelpTopic[String%, Object] | Gets the help topic. This property is deprecated. (Inherited from _CommandBarButton.) |
|
accKeyboardShortcut[Object] | Gets the keyboard shortcut. This property is deprecated. (Inherited from _CommandBarButton.) |
|
accName[Object] | Gets the name of the object. (Inherited from _CommandBarButton.) |
|
accParent | Gets the parent. This property is deprecated. (Inherited from _CommandBarButton.) |
|
accRole[Object] | Gets the role. This property is deprecated. (Inherited from _CommandBarButton.) |
|
accSelection | Gets the selection. This property is deprecated. (Inherited from _CommandBarButton.) |
|
accState[Object] | Gets the state. This property is deprecated. (Inherited from _CommandBarButton.) |
|
accValue[Object] | Gets the value. This property is deprecated. (Inherited from _CommandBarButton.) |
|
Application | Gets the DTE object. (Inherited from _CommandBarButton.) |
|
BeginGroup | Determines whether this control is the first in its group. (Inherited from _CommandBarButton.) |
|
BuiltIn | Determines whether this control is a custom control or a built-in control. (Inherited from _CommandBarButton.) |
|
BuiltInFace | The built-in image. This property is deprecated. (Inherited from _CommandBarButton.) |
|
Caption | Gets the caption of the control. (Inherited from _CommandBarButton.) |
|
Control | Gets the control itself. (Inherited from _CommandBarButton.) |
|
Creator | Gets the ID of the application. (Inherited from _CommandBarButton.) |
|
DescriptionText | Always returns the empty string. (Inherited from _CommandBarButton.) |
|
Enabled | Determines whether the control is enabled. (Inherited from _CommandBarButton.) |
|
FaceId | This property is deprecated. (Inherited from _CommandBarButton.) |
|
Height | Gets the height of the button. (Inherited from _CommandBarButton.) |
|
HelpContextId | Gets the help context ID. Always returns 0. (Inherited from _CommandBarButton.) |
|
HelpFile | Always returns the empty string. (Inherited from _CommandBarButton.) |
|
HyperlinkType | Gets the hyperlink type. This property is deprecated. (Inherited from _CommandBarButton.) |
|
Id | Gets the identifier of the button. (Inherited from _CommandBarButton.) |
|
Index | Gets the index of this control in the set of controls on the command bar. (Inherited from _CommandBarButton.) |
|
InstanceId | Gets the instance ID of this control. (Inherited from _CommandBarButton.) |
|
IsPriorityDropped | Determines whether the priority has been lowered. Always returns false. (Inherited from _CommandBarButton.) |
|
Left | Gets the left coordinates. This property is deprecated. (Inherited from _CommandBarButton.) |
|
Mask | Gets the mask. This property is deprecated. (Inherited from _CommandBarButton.) |
|
OLEUsage | Gets or sets the OLE usage. This property is deprecated. (Inherited from _CommandBarButton.) |
|
OnAction | Gets or sets the OnAction string. (Inherited from _CommandBarButton.) |
|
Parameter | Gets or sets the parameter that is used with the command. (Inherited from _CommandBarButton.) |
|
Parent | Gets the parent command bar. (Inherited from _CommandBarButton.) |
|
Picture | Gets or sets the icon that appears on the button. (Inherited from _CommandBarButton.) |
|
Priority | Gets the priority. Always returns 1. (Inherited from _CommandBarButton.) |
|
ShortcutText | Gets or sets the shortcut text. This property is deprecated. (Inherited from _CommandBarButton.) |
|
State | Gets or sets the state. This property is deprecated. (Inherited from _CommandBarButton.) |
|
Style | Gets or sets the button style. (Inherited from _CommandBarButton.) |
|
Tag | Gets or sets the tag. Not used in Visual Studio. (Inherited from _CommandBarButton.) |
|
TooltipText | Gets or sets the tooltip text. (Inherited from _CommandBarButton.) |
|
Top | Gets the top. This property is deprecated. (Inherited from _CommandBarButton.) |
|
Type | Gets the type of the control. (Inherited from _CommandBarButton.) |
|
Visible | Determines whether this control is visible. (Inherited from _CommandBarButton.) |
|
Width | Gets or sets the width of the control. (Inherited from _CommandBarButton.) |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
accDoDefaultAction(Object) | Performs the default action. This method is deprecated. (Inherited from _CommandBarButton.) |
|
accHitTest(Int32, Int32) | Gets the object at the specified coordinates. This method is deprecated. (Inherited from _CommandBarButton.) |
|
accLocation(Int32%, Int32%, Int32%, Int32%, Object) | Gets the location of the control. This method is deprecated. (Inherited from _CommandBarButton.) |
|
accNavigate(Int32, Object) | Navigates to another object. This method is deprecated. (Inherited from _CommandBarButton.) |
|
accSelect(Int32, Object) | Selects an object. This method is deprecated. (Inherited from _CommandBarButton.) |
|
add_Click | (Inherited from _CommandBarButtonEvents_Event.) |
|
Copy(Object, Object) | Copies this control to the specified position on the specified command bar. (Inherited from _CommandBarButton.) |
|
CopyFace | Copies the image. This method is deprecated. (Inherited from _CommandBarButton.) |
|
Delete(Object) | Removes this control from the collection. (Inherited from _CommandBarButton.) |
|
Execute() | Performs the action of this control. (Inherited from _CommandBarButton.) |
|
Move(Object, Object) | Moves this control to the specified command bar at the specified position. (Inherited from _CommandBarButton.) |
|
PasteFace | Pastes the image. This method is deprecated. (Inherited from _CommandBarButton.) |
|
remove_Click | (Inherited from _CommandBarButtonEvents_Event.) |
|
Reserved1() | Reserved. (Inherited from _CommandBarButton.) |
|
Reserved2() | Reserved. (Inherited from _CommandBarButton.) |
|
Reserved3() | Reserved. (Inherited from _CommandBarButton.) |
|
Reserved4() | Reserved. (Inherited from _CommandBarButton.) |
|
Reserved5() | Reserved. (Inherited from _CommandBarButton.) |
|
Reserved6() | Reserved. (Inherited from _CommandBarButton.) |
|
Reserved7() | Reserved. (Inherited from _CommandBarButton.) |
|
Reset() | Resets the button. (Inherited from _CommandBarButton.) |
|
SetFocus() | Sets the focus. (Inherited from _CommandBarButton.) |
Top
Events
| Name | Description | |
|---|---|---|
.gif "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.