Sdílet prostřednictvím


Commands2.AddNamedCommand2-Methode

Aktualisiert: November 2007

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
'Usage
Dim instance As Commands2
Dim AddInInstance As AddIn
Dim Name As String
Dim ButtonText As String
Dim Tooltip As String
Dim MSOButton As Boolean
Dim Bitmap As Object
Dim ContextUIGUIDs As Object()
Dim vsCommandStatusValue As Integer
Dim CommandStyleFlags As Integer
Dim ControlType As vsCommandControlType
Dim returnValue As Command

returnValue = instance.AddNamedCommand2(AddInInstance, _
    Name, ButtonText, Tooltip, MSOButton, _
    Bitmap, ContextUIGUIDs, vsCommandStatusValue, _
    CommandStyleFlags, ControlType)
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
)
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 den Mauszeiger über eines der an den neuen Befehl gebundenen Steuerelemente hält.

  • MSOButton
    Typ: System.Boolean

    Erforderlich. Zeigt an, ob das Schaltflächenbild für den benannten Befehl ein Office-Bild ist. True = Schaltfläche. Wenn MSOButtonFalse ist, dann ist Bitmap die ID einer 16x16-Bitmapressource (aber keiner Symbolressource) in einer Ressourcen-DLL von Visual C++, die sich in einem Ordner mit dem Gebietsschemabezeichner der Sprache (z. B. 1033 für Englisch) befindet.

  • Bitmap
    Typ: System.Object

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

  • ContextUIGUIDs
    Typ: array<System.Object[]%

    Optional. Ein SafeArray von GUIDs, das bestimmt, mit welchen Umgebungskontexten (d. h. Debugmodus, Entwurfsmodus usw.) der Befehl aktiviert wird. Siehe 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

    Wert aus der vsCommandStyle-Enumeration. Steuert das visuelle Format beliebiger Benutzeroberflächenelemente für diesen Befehl.

Rückgabewert

Typ: EnvDTE.Command

Der benannte Befehl, der erstellt wurde.

Berechtigungen

Siehe auch

Referenz

Commands2-Schnittstelle

Commands2-Member

EnvDTE80-Namespace