Compartilhar via


CommandBarButtonClass Class

See T[:Microsoft.VisualStudio.CommandBars._CommandBarButton] for details.

Inheritance Hierarchy

Object
  Microsoft.VisualStudio.CommandBars.CommandBarButtonClass

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

Syntax

'Declaration
<GuidAttribute("E322950C-AAF9-43DF-A328-62A1A7E96AA6")> _
<ClassInterfaceAttribute()> _
Public Class CommandBarButtonClass _
    Implements _CommandBarButton, CommandBarButton, _CommandBarButtonEvents_Event
[GuidAttribute("E322950C-AAF9-43DF-A328-62A1A7E96AA6")]
[ClassInterfaceAttribute()]
public class CommandBarButtonClass : _CommandBarButton, 
    CommandBarButton, _CommandBarButtonEvents_Event
[GuidAttribute(L"E322950C-AAF9-43DF-A328-62A1A7E96AA6")]
[ClassInterfaceAttribute()]
public ref class CommandBarButtonClass : _CommandBarButton, 
    CommandBarButton, _CommandBarButtonEvents_Event
[<GuidAttribute("E322950C-AAF9-43DF-A328-62A1A7E96AA6")>]
[<ClassInterfaceAttribute()>]
type CommandBarButtonClass =  
    class 
        interface _CommandBarButton 
        interface CommandBarButton 
        interface _CommandBarButtonEvents_Event 
    end
public class CommandBarButtonClass implements _CommandBarButton, CommandBarButton, _CommandBarButtonEvents_Event

The CommandBarButtonClass type exposes the following members.

Properties

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

Top

Methods

  Name Description
Public method accDoDefaultAction Performs the default action. This method is deprecated.
Public method accHitTest Gets the object at the specified coordinates. This method is deprecated.
Public method accLocation Gets the location of the control. This method is deprecated.
Public method accNavigate Navigates to another object. This method is deprecated.
Public method accSelect Selects an object. This method is deprecated.
Public method add_Click Adds the click event handler.
Public method Copy Copies this control to the specified position on the specified command bar.
Public method CopyFace Copies the face. This method is deprecated.
Public method Delete Removes this control from the collection.
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method Execute Performs the action of this control.
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method Move Moves this control to the specified command bar at the specified position.
Public method PasteFace Pastes the face. This method is deprecated.
Public method remove_Click Removes the click event handler.
Public method Reserved1 Reserved.
Public method Reserved2 Reserved.
Public method Reserved3 Reserved.
Public method Reserved4 Reserved.
Public method Reserved5 Reserved.
Public method Reserved6 Reserved.
Public method Reserved7 Reserved.
Public method Reset Resets the control.
Public method SetFocus Sets the focus on the control.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Events

  Name Description
Public event Click Raises this event when the control is clicked.

Top

Remarks

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

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.VisualStudio.CommandBars Namespace