CommandBarButton Interface
Definition
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.
Represents the command bar button.
public interface class CommandBarButton : Microsoft::VisualStudio::CommandBars::_CommandBarButton, Microsoft::VisualStudio::CommandBars::_CommandBarButtonEvents_Eventpublic interface class CommandBarButton : Microsoft::VisualStudio::CommandBars::_CommandBarButton, Microsoft::VisualStudio::CommandBars::_CommandBarButtonEvents_Event__interface CommandBarButton : Microsoft::VisualStudio::CommandBars::_CommandBarButton, Microsoft::VisualStudio::CommandBars::_CommandBarButtonEvents_Event[System.Runtime.InteropServices.CoClass(typeof(Microsoft.VisualStudio.CommandBars.CommandBarButtonClass))]
[System.Runtime.InteropServices.Guid("E11C7CE2-8641-4183-9458-309C6A201CDD")]
public interface CommandBarButton : Microsoft.VisualStudio.CommandBars._CommandBarButton, Microsoft.VisualStudio.CommandBars._CommandBarButtonEvents_Event[System.Runtime.InteropServices.CoClass(typeof(Microsoft.VisualStudio.CommandBars.CommandBarButtonClass))]
[System.Runtime.InteropServices.Guid("E11C7CE2-8641-4183-9458-309C6A201CDD")]
[System.Runtime.InteropServices.ComVisible(false)]
public interface CommandBarButton : Microsoft.VisualStudio.CommandBars._CommandBarButton, Microsoft.VisualStudio.CommandBars._CommandBarButtonEvents_Event[<System.Runtime.InteropServices.CoClass(typeof(Microsoft.VisualStudio.CommandBars.CommandBarButtonClass))>]
[<System.Runtime.InteropServices.Guid("E11C7CE2-8641-4183-9458-309C6A201CDD")>]
type CommandBarButton = interface
interface _CommandBarButton
interface _CommandBarButtonEvents_Event[<System.Runtime.InteropServices.CoClass(typeof(Microsoft.VisualStudio.CommandBars.CommandBarButtonClass))>]
[<System.Runtime.InteropServices.Guid("E11C7CE2-8641-4183-9458-309C6A201CDD")>]
[<System.Runtime.InteropServices.ComVisible(false)>]
type CommandBarButton = interface
interface _CommandBarButton
interface CommandBarControl
interface _IVsMsoOleAccDispObj
interface IAccessible
interface _CommandBarButtonEvents_EventPublic Interface CommandBarButton
Implements _CommandBarButton, _CommandBarButtonEvents_Event- Derived
- Attributes
- Implements
Remarks
A _CommandBarButton implements only CommandBarControl, which defines no events. A CommandBarButton implements both _CommandBarButton and _CommandBarButtonEvents_Event. CommandBarButtonClass implements all three interfaces.
Properties
| accChild[Object] | (Inherited from IAccessible) |
| accChildCount |
Gets the number of children. This property is deprecated. (Inherited from IAccessible) |
| accDefaultAction[Object] |
Gets the default action. This property is deprecated. (Inherited from IAccessible) |
| accDescription[Object] |
Gets the description. This property is deprecated. (Inherited from IAccessible) |
| accFocus |
Gets the focus. This property is deprecated. (Inherited from IAccessible) |
| accHelp[Object] |
Gets the help string. This property is deprecated. (Inherited from IAccessible) |
| accHelpTopic[String, Object] |
Gets the help topic. This property is deprecated. (Inherited from IAccessible) |
| accKeyboardShortcut[Object] |
Gets the keyboard shortcut. This property is deprecated. (Inherited from IAccessible) |
| accName[Object] |
Gets the name of the object. (Inherited from IAccessible) |
| accParent |
Gets the parent. This property is deprecated. (Inherited from IAccessible) |
| accRole[Object] |
Gets the role. This property is deprecated. (Inherited from IAccessible) |
| accSelection |
Gets the selection. This property is deprecated. (Inherited from IAccessible) |
| accState[Object] |
Gets the state. This property is deprecated. (Inherited from IAccessible) |
| accValue[Object] |
Gets the value. This property is deprecated. (Inherited from IAccessible) |
| Application |
Gets the DTE object. (Inherited from CommandBarControl) |
| BeginGroup |
Determines whether this control is the first in its group. (Inherited from CommandBarControl) |
| BuiltIn |
Determines whether this control is a custom control or a built-in control. (Inherited from CommandBarControl) |
| BuiltInFace |
The built-in image. This property is deprecated. (Inherited from _CommandBarButton) |
| Caption |
Gets or sets the caption of the control. (Inherited from CommandBarControl) |
| Control |
Gets the control itself. (Inherited from CommandBarControl) |
| Creator |
Gets the ID of the application. (Inherited from CommandBarControl) |
| DescriptionText |
Always returns the empty string. (Inherited from CommandBarControl) |
| Enabled |
Determines whether the control is enabled. (Inherited from CommandBarControl) |
| FaceId |
This property is deprecated. (Inherited from _CommandBarButton) |
| Height |
Gets or sets the height of the control. (Inherited from CommandBarControl) |
| HelpContextId |
Gets the help context ID. Always returns 0. (Inherited from CommandBarControl) |
| HelpFile |
Always returns the empty string. (Inherited from CommandBarControl) |
| HyperlinkType |
Gets the hyperlink type. This property is deprecated. (Inherited from _CommandBarButton) |
| Id |
Gets the ID of the control. (Inherited from CommandBarControl) |
| Index |
Gets the index of this control in the set of controls on the command bar. (Inherited from CommandBarControl) |
| InstanceId |
Gets the instance ID of this control. (Inherited from CommandBarControl) |
| IsPriorityDropped |
Always returns |
| Left |
Gets the left coordinates. This property is deprecated. (Inherited from CommandBarControl) |
| Mask |
Gets the mask. This property is deprecated. (Inherited from _CommandBarButton) |
| OLEUsage |
Gets or sets the OLE usage. This property is deprecated. (Inherited from CommandBarControl) |
| OnAction |
Gets or sets the OnAction string. (Inherited from CommandBarControl) |
| Parameter |
Gets or sets the parameter that is used with the command. (Inherited from CommandBarControl) |
| Parent |
Gets the parent command bar. (Inherited from CommandBarControl) |
| Picture |
Gets or sets the icon that appears on the button. (Inherited from _CommandBarButton) |
| Priority |
Gets the priority. Always returns 1. (Inherited from CommandBarControl) |
| 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 (Inherited from CommandBarControl) |
| TooltipText |
Gets or sets the tooltip text. (Inherited from CommandBarControl) |
| Top |
Gets the top. This property is deprecated. (Inherited from CommandBarControl) |
| Type |
Gets the type of the control. (Inherited from CommandBarControl) |
| Visible |
Determines whether this control is visible. (Inherited from CommandBarControl) |
| Width |
Gets or sets the width of the control. (Inherited from CommandBarControl) |
Methods
| accDoDefaultAction(Object) |
Performs the default action. (Inherited from IAccessible) |
| accHitTest(Int32, Int32) |
Gets the object at the specified coordinates. This method is deprecated. (Inherited from IAccessible) |
| accLocation(Int32, Int32, Int32, Int32, Object) |
Gets the location of the control. This method is deprecated. (Inherited from IAccessible) |
| accNavigate(Int32, Object) |
Navigates to another object. This method is deprecated. (Inherited from IAccessible) |
| accSelect(Int32, Object) |
Selects an object. This method is deprecated. (Inherited from IAccessible) |
| add_Click(_CommandBarButtonEvents_ClickEventHandler) | (Inherited from _CommandBarButtonEvents_Event) |
| Copy(Object, Object) |
Copies this control to the specified position on the specified command bar. (Inherited from CommandBarControl) |
| CopyFace() |
Copies the image. This method is deprecated. (Inherited from _CommandBarButton) |
| Delete(Object) |
Removes this control from the collection. (Inherited from CommandBarControl) |
| Execute() |
Performs the action of this control. (Inherited from CommandBarControl) |
| Move(Object, Object) |
Moves this control to the specified command bar at the specified position. (Inherited from CommandBarControl) |
| PasteFace() |
Pastes the image. This method is deprecated. (Inherited from _CommandBarButton) |
| remove_Click(_CommandBarButtonEvents_ClickEventHandler) | (Inherited from _CommandBarButtonEvents_Event) |
| Reserved1() |
Reserved. (Inherited from CommandBarControl) |
| Reserved2() |
Reserved. (Inherited from CommandBarControl) |
| Reserved3() |
Reserved. (Inherited from CommandBarControl) |
| Reserved4() |
Reserved. (Inherited from CommandBarControl) |
| Reserved5() |
Reserved. (Inherited from CommandBarControl) |
| Reserved6() |
Reserved. (Inherited from CommandBarControl) |
| Reserved7() |
Reserved. (Inherited from CommandBarControl) |
| Reset() |
Resets the control. (Inherited from CommandBarControl) |
| SetFocus() |
Sets the focus on the control. (Inherited from CommandBarControl) |
Events
| Click |
The click event. Microsoft Internal Use Only. (Inherited from _CommandBarButtonEvents_Event) |