Commands2::AddNamedCommand Method (AddIn^, String^, String^, String^, Boolean, Int32, array<Object^>^, Int32)
Creates a named command that is saved by the environment and made available the next time the environment starts.
Assembly: EnvDTE80 (in EnvDTE80.dll)
Command^ AddNamedCommand( AddIn^ AddInInstance, String^ Name, String^ ButtonText, String^ Tooltip, bool MSOButton, int Bitmap = 0, [InAttribute] array<Object^>^% ContextUIGUIDs, int vsCommandDisabledFlagsValue = 16 )
Parameters
- AddInInstance
-
Type:
EnvDTE::AddIn^
Required. The AddIn object that is adding the new command.
- Name
-
Type:
System::String^
Required. The short form of the name for your new command. AddNamedCommand prefaces this with "Addins.Progid." to create a unique name.
- ButtonText
-
Type:
System::String^
Required. The name to use if the command is bound to a button that is displayed by name rather than by icon.
- Tooltip
-
Type:
System::String^
Required. The text displayed when a user hovers the mouse pointer over any control bound to the new command.
- MSOButton
-
Type:
System::Boolean
Required. Should always be false.
- Bitmap
-
Type:
System::Int32
Optional. The ID of a bitmap to display on the button.
- ContextUIGUIDs
-
Type:
array<System::Object^>^
Optional. The GUIDs that determine which environment contexts (that is, debug mode, design mode, and so on) show the command
- vsCommandDisabledFlagsValue
-
Type:
System::Int32
Optional. Determines the state of the command when you supply a ContextUIGUIDs and none of the specified contexts are currently active. This parameter should always include vsCommandStatusSupported. If it also includes vsCommandStatusEnabled, the command will be enabled.
You can later change the ButtonText name by responding to the QueryStatus method. If the text begins with #, then the rest of the string is an integer that represents a resource ID in the registered satellite DLL.
The ContextUIGUIDs parameter and the vsCommandStatusValue parameter are used when the add-in is not loaded and thus cannot respond to the QueryStatus method. If ContextUIGUIDs is empty, then the command is enabled until the add-in is loaded and can respond to QueryStatus.
The addin can receive invocation notification through the IDTCommandTarget interface. A button can be added by using the OnConnection method of the IDTExtensibility2 interface.