Commands2.AddNamedCommand-Methode

Erstellt einen benannten Befehl, der von der Umgebung gespeichert wird und beim nächsten Start der Umgebung zur Verfügung steht, auch wenn das Add-In beim Umgebungsstart nicht geladen wird.

Namespace:  EnvDTE80
Assembly:  EnvDTE80 (in EnvDTE80.dll)

Syntax

'Declaration
Function AddNamedCommand ( _
    AddInInstance As AddIn, _
    Name As String, _
    ButtonText As String, _
    Tooltip As String, _
    MSOButton As Boolean, _
    Bitmap As Integer, _
    ByRef ContextUIGUIDs As Object(), _
    vsCommandDisabledFlagsValue As Integer _
) As Command

Command AddNamedCommand(
    AddIn AddInInstance,
    string Name,
    string ButtonText,
    string Tooltip,
    bool MSOButton,
    int Bitmap,
    ref Object[] ContextUIGUIDs,
    int vsCommandDisabledFlagsValue
)

Command^ AddNamedCommand(
    [InAttribute] AddIn^ AddInInstance, 
    [InAttribute] String^ Name, 
    [InAttribute] String^ ButtonText, 
    [InAttribute] String^ Tooltip, 
    [InAttribute] bool MSOButton, 
    [InAttribute] int Bitmap, 
    [InAttribute] array<Object^>^% ContextUIGUIDs, 
    [InAttribute] int vsCommandDisabledFlagsValue
)

abstract AddNamedCommand : 
        AddInInstance:AddIn * 
        Name:string * 
        ButtonText:string * 
        Tooltip:string * 
        MSOButton:bool * 
        Bitmap:int * 
        ContextUIGUIDs:Object[] byref * 
        vsCommandDisabledFlagsValue:int -> Command

function AddNamedCommand(
    AddInInstance : AddIn, 
    Name : String, 
    ButtonText : String, 
    Tooltip : String, 
    MSOButton : boolean, 
    Bitmap : int, 
    ContextUIGUIDs : Object[], 
    vsCommandDisabledFlagsValue : int
) : Command

Parameter

• AddInInstance
  Typ: AddIn

  Erforderlich. Das AddIn-Objekt, das den neuen Befehl hinzufügen.

• Name
  Typ: String

  Erforderlich. Die Kurzform des Namens für den neuen Befehl. AddNamedCommand verwendet das Präfix "Addins.Progid.", um einen eindeutigen Namen zu erstellen.

• ButtonText
  Typ: String

  Erforderlich. Der zu verwendende Name, wenn der Befehl an eine Schaltfläche gebunden ist, die anstelle des Symbols mit ihrem Namen angezeigt wird.

• Tooltip
  Typ: String

  Erforderlich. Der angezeigte Text, wenn ein Benutzer mit dem Mauszeiger auf eines der an den neuen Befehl gebundenen Steuerelemente zeigt.

• MSOButton
  Typ: Boolean

  Erforderlich. Immer sein sollte false.

• Bitmap
  Typ: Int32

  Optional. Die ID einer auf der Schaltfläche anzuzeigenden Bitmap.

• ContextUIGUIDs
  Typ: array<Object[]%

  Optional. Die GUIDs, die bestimmen, welche Umgebungskontexte (das heißt, den Debugmodus, Entwurfsmodus, usw.). dem Befehl anzeigen

• vsCommandDisabledFlagsValue
  Typ: Int32

  Optional. Bestimmt den Zustand des Befehls, wenn Sie ContextUIGUIDs angeben und keiner der angegebenen Kontexte derzeit aktiv ist. Dieser Parameter sollte stets vsCommandStatusSupported enthalten. Wenn auch vsCommandStatusEnabled enthalten ist, wird der Befehl aktiviert.

Rückgabewert

Typ: Command
Ein Command-Objekt.

Hinweise

Add-Ins können später den ButtonText-Namen ändern, indem sie auf die QueryStatus-Methode reagieren. Wenn der Text mit # beginnt, besteht der Rest der Zeichenfolge aus einer ganzen Zahl, die eine Ressourcen-ID in der registrierten Satellite-DLL des Add-Ins darstellt.

Der ContextUIGUIDs-Parameter und der vsCommandStatusValue-Parameter werden verwendet, wenn das Add-In nicht geladen wird und daher nicht auf die QueryStatus-Methode reagieren kann. Wenn ContextUIGUIDs leer ist, bleibt der Befehl so lange aktiviert, bis das Add-In geladen wurde und auf QueryStatus antworten kann.

Das Add-In kann Aufrufbenachrichtigungen über die IDTCommandTarget-Schnittstelle empfangen. Mit der OnConnection-Methode der IDTExtensibility2-Schnittstelle kann eine Schaltfläche hinzugefügt werden.

Beispiele

Imports Microsoft.VisualStudio.CommandBars
Sub AddControlExample()
   ' Before running, you must add a reference to the Office 
   ' typelib to gain access to the CommandBar object. Also, for this 
   ' example to work correctly, there should be an add-in available 
   ' in the Visual Studio environment.
   Dim cmds As Commands
   Dim cmdobj As Command
   Dim cmdbarobj As CommandBar
   Dim colAddins As AddIns

   ' Set references.
   colAddins = DTE.AddIns()
   cmds = DTE.Commands
   cmdobj = cmds.Item("File.NewFile")

   ' Create a toolbar and add the File.NewFile command to it.
   cmds.AddCommandBar("Mycmdbar", vsCommandBarType.vsCommandBarTypeToolbar)
   MsgBox("Commandbar name: " & cmdbarobj.Name)
   cmdobj.AddControl(cmdbarobj)
   cmds.AddNamedCommand(colAddins.Item(1), "MyCommand", "Button Text", "Some tooltip", True)
End Sub

.NET Framework-Sicherheit

• Volle Vertrauenswürdigkeit für den unmittelbaren Aufrufer. Dieser Member kann von nur teilweise vertrauenswürdigem Code nicht verwendet werden. Weitere Informationen finden Sie unter Verwenden von Bibliotheken aus teilweise vertrauenswürdigem Code.

Siehe auch

Referenz

Commands2 Schnittstelle

EnvDTE80-Namespace