Commands2.AddNamedCommand2-Methode

  • Artikel

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 AddNamedCommand2 ( _
    AddInInstance As AddIn, _
    Name As String, _
    ButtonText As String, _
    Tooltip As String, _
    MSOButton As Boolean, _
    Bitmap As Object, _
    ByRef ContextUIGUIDs As Object(), _
    vsCommandStatusValue As Integer, _
    CommandStyleFlags As Integer, _
    ControlType As vsCommandControlType _
) As Command

Command AddNamedCommand2(
    AddIn AddInInstance,
    string Name,
    string ButtonText,
    string Tooltip,
    bool MSOButton,
    Object Bitmap,
    ref Object[] ContextUIGUIDs,
    int vsCommandStatusValue,
    int CommandStyleFlags,
    vsCommandControlType ControlType
)

Command^ AddNamedCommand2(
    [InAttribute] AddIn^ AddInInstance, 
    [InAttribute] String^ Name, 
    [InAttribute] String^ ButtonText, 
    [InAttribute] String^ Tooltip, 
    [InAttribute] bool MSOButton, 
    [InAttribute] Object^ Bitmap, 
    [InAttribute] array<Object^>^% ContextUIGUIDs, 
    [InAttribute] int vsCommandStatusValue, 
    [InAttribute] int CommandStyleFlags, 
    [InAttribute] vsCommandControlType ControlType
)

abstract AddNamedCommand2 : 
        AddInInstance:AddIn * 
        Name:string * 
        ButtonText:string * 
        Tooltip:string * 
        MSOButton:bool * 
        Bitmap:Object * 
        ContextUIGUIDs:Object[] byref * 
        vsCommandStatusValue:int * 
        CommandStyleFlags:int * 
        ControlType:vsCommandControlType -> Command 

function AddNamedCommand2(
    AddInInstance : AddIn, 
    Name : String, 
    ButtonText : String, 
    Tooltip : String, 
    MSOButton : boolean, 
    Bitmap : Object, 
    ContextUIGUIDs : Object[], 
    vsCommandStatusValue : int, 
    CommandStyleFlags : int, 
    ControlType : vsCommandControlType
) : Command

Parameter

  • AddInInstance
    Typ: EnvDTE.AddIn
    Erforderlich.Das AddIn-Objekt fügt den neuen Befehl hinzu.
  • Name
    Typ: System.String
    Erforderlich.Die Kurzform des Namens für den neuen Befehl. AddNamedCommand2 verwendet das Präfix Addins.Progid., um einen eindeutigen Namen zu erstellen.
  • ButtonText
    Typ: System.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: System.String
    Erforderlich.Der angezeigte Text, wenn ein Benutzer mit dem Mauszeiger auf eines der an den neuen Befehl gebundenen Steuerelemente zeigt.
  • MSOButton
    Typ: System.Boolean
    Erforderlich.Gibt an, wie der Bitmapparameter interpretiert wird.
    Wenn der Wert true ist, ist Bitmap die ID einer Microsoft Office-Bitmap.
    Wenn MSOButtonfalse ist, kann Bitmap eines der Folgenden sein:
    - Eine Bitmap
    - Ein Icon
    - Ein IPicture
    - Die ID einer vom Add-In bereitgestellten 16x16-Bitmapressource (jedoch keine Symbolressource).Visual Studio sucht zunächst in der Satelliten-DLL des Add-Ins.Wenn die Ressource dort nicht gefunden wird, wird die Add-In-DLL durchsucht.
  • Bitmap
    Typ: System.Object
    Optional.Die ID einer auf der Schaltfläche anzuzeigenden Bitmap.Weitere Informationen finden Sie unter MSOButton.
  • ContextUIGUIDs
    Typ: array<System.Object[]%
    Optional.Ein SafeArray von GUIDs, das die Umgebungskontexte (d. h. Debugmodus, Entwurfsmodus usw.) bestimmt, in denen der Befehl angezeigt wird.Weitere Informationen finden Sie unter vsCommandDisabledFlags.
  • vsCommandStatusValue
    Typ: System.Int32
    Optional.Bestimmt, ob der Befehl im deaktivierten Zustand unsichtbar oder grau angezeigt wird, wenn Sie ContextUIGUIDs angeben und derzeit keine aktiv sind.
  • CommandStyleFlags
    Typ: System.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: EnvDTE.Command
Der benannte Befehl, der erstellt wurde.

Hinweise

Weitere Informationen dazu, wie Sie die Bit-Übersichts-ID Attributwerte von MSO-Schaltflächen finden Sie unter abruft Listing Button Faces in the Command Bar for the Microsoft Office System.

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.

.NET Framework-Sicherheit

Siehe auch

Referenz

Commands2 Schnittstelle

EnvDTE80-Namespace