CommandBarButtonClass Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.CommandBars

Assembly:: Microsoft.VisualStudio.CommandBars.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

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.

See T_CommandBarButton for details.

public ref class CommandBarButtonClass : Microsoft::VisualStudio::CommandBars::CommandBarButton

public ref class CommandBarButtonClass

[Windows::Foundation::Metadata::WebHostHidden]
public ref class CommandBarButtonClass : Microsoft::VisualStudio::CommandBars::CommandBarButton

[Windows::Foundation::Metadata::WebHostHidden]
class CommandBarButtonClass : Microsoft::VisualStudio::CommandBars::CommandBarButton

[System.Runtime.InteropServices.ClassInterface(0)]
[System.Runtime.InteropServices.ComSourceInterfaces("Microsoft.VisualStudio.CommandBars._CommandBarButtonEvents\0")]
[System.Runtime.InteropServices.Guid("E322950C-AAF9-43DF-A328-62A1A7E96AA6")]
public class CommandBarButtonClass : Microsoft.VisualStudio.CommandBars.CommandBarButton

[System.Runtime.InteropServices.Guid("E322950C-AAF9-43DF-A328-62A1A7E96AA6")]
[System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.None)]
[System.Runtime.InteropServices.ComSourceInterfaces("Microsoft.VisualStudio.CommandBars._CommandBarButtonEvents")]
[System.Runtime.InteropServices.ComVisible(false)]
public class CommandBarButtonClass

[<System.Runtime.InteropServices.ClassInterface(0)>]
[<System.Runtime.InteropServices.ComSourceInterfaces("Microsoft.VisualStudio.CommandBars._CommandBarButtonEvents\0")>]
[<System.Runtime.InteropServices.Guid("E322950C-AAF9-43DF-A328-62A1A7E96AA6")>]
type CommandBarButtonClass = class
    interface _CommandBarButton
    interface CommandBarButton
    interface _CommandBarButtonEvents_Event

[<System.Runtime.InteropServices.Guid("E322950C-AAF9-43DF-A328-62A1A7E96AA6")>]
[<System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.None)>]
[<System.Runtime.InteropServices.ComSourceInterfaces("Microsoft.VisualStudio.CommandBars._CommandBarButtonEvents")>]
[<System.Runtime.InteropServices.ComVisible(false)>]
type CommandBarButtonClass = class

Public Class CommandBarButtonClass
Implements CommandBarButton

Public Class CommandBarButtonClass

Inheritance: Object
CommandBarButtonClass

Attributes: ClassInterfaceAttribute ComSourceInterfacesAttribute GuidAttribute ComVisibleAttribute

Implements: _CommandBarButton _CommandBarButtonEvents_Event _IVsMsoOleAccDispObj CommandBarButton CommandBarControl IAccessible

Remarks

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

Constructors

CommandBarButtonClass()

Properties

accChild[Object]	Gets the child. This property is deprecated.
accChildCount	Gets the number of children. This property is deprecated.
accDefaultAction[Object]	Gets the default action. This property is deprecated.
accDescription[Object]	Gets the description. This property is deprecated.
accFocus	Gets the focus. This property is deprecated.
accHelp[Object]	Gets the help. This property is deprecated.
accHelpTopic[String, Object]	Gets the help topic. This property is deprecated.
accKeyboardShortcut[Object]	Gets the keyboard shortcut. This property is deprecated.
accName[Object]	Gets the name of the object.
accParent	Gets the parent. This property is deprecated.
accRole[Object]	Gets the role. This property is deprecated.
accSelection	Gets the selection. This property is deprecated.
accState[Object]	Gets the state. This property is deprecated.
accValue[Object]	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	Gets the 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.

Methods

accDoDefaultAction(Object)	Performs the default action. This method is deprecated.
accHitTest(Int32, Int32)	Gets the object at the specified coordinates. This method is deprecated.
accLocation(Int32, Int32, Int32, Int32, Object)	Gets the location of the control. This method is deprecated.
accNavigate(Int32, Object)	Navigates to another object. This method is deprecated.
accSelect(Int32, Object)	Selects an object. This method is deprecated.
add_Click(_CommandBarButtonEvents_ClickEventHandler)
Copy(Object, Object)	Copies this control to the specified position on the specified command bar.
CopyFace()	Copies the face. This method is deprecated.
Delete(Object)	Removes this control from the collection.
Execute()	Performs the action of this control.
Move(Object, Object)	Moves this control to the specified command bar at the specified position.
PasteFace()	Pastes the face. This method is deprecated.
remove_Click(_CommandBarButtonEvents_ClickEventHandler)
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.

Events

Click

Raises this event when the control is clicked.

Applies to

Share via