CommandBarButtonClass Class

Article
07/12/2014

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

Inheritance Hierarchy

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

Top

Methods

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

Top

Events

	Name	Description
	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.