Commands2.AddNamedCommand – metoda
Vytvoří pojmenované příkaz, který je uložil na životní prostředí a k dispozici při dalším spuštění prostředí i v případě, že doplněk není načten při spuštění prostředí.
Obor názvů: EnvDTE80
Sestavení: EnvDTE80 (v EnvDTE80.dll)
Syntaxe
'Deklarace
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
Parametry
AddInInstance
Typ: AddInPožadováno.AddIn Objekt, který přidává nový příkaz.
Name
Typ: StringPožadováno.Zkratka pro název nového příkazu.AddNamedCommandprefaces to s "Addins.Progid." vytvořit jedinečný název.
ButtonText
Typ: StringPožadováno.Název pro použití v případě, že příkaz je vázán na ovládací prvek, který je zobrazen podle názvu a nikoli podle ikony.
Tooltip
Typ: StringPožadováno.Text zobrazený při nastavení ukazatele myši nad všechny ovládací prvky vázané na nový příkaz.
MSOButton
Typ: BooleanPožadováno.By měla být vždy false.
Bitmap
Typ: Int32Volitelné.ID rastrový obrázek na tlačítku zobrazit.
ContextUIGUIDs
Typ: array<Object[]%Volitelné.Identifikátory GUID určující příkaz Zobrazit které kontexty prostředí (to znamená, že režim ladění, návrhovém režimu atd.)
vsCommandDisabledFlagsValue
Typ: Int32Volitelné.Určuje stav příkazu zadáte ContextUIGUIDs a žádný zadaný kontext je právě aktivní.Tento parametr by měl vždy obsahovat vsCommandStatusSupported.Pokud obsahuje také vsCommandStatusEnabled, příkaz bude povolena.
Vrácená hodnota
Typ: Command
Objekt Command.
Poznámky
Doplňky lze později změnit ButtonText název odpovědi na QueryStatus metody.Pokud text začíná znakem #, zbytek řetězce je celé číslo, které představuje ID prostředku v doplňku na registrované satelitní knihovny DLL.
ContextUIGUIDs Parametr a vsCommandStatusValue parametr při doplněk není načten a nemůže tedy reagovat na QueryStatus metody.Pokud ContextUIGUIDs je prázdný, a pak příkaz je povolen, dokud doplněk načten a může reagovat na QueryStatus.
Tohoto doplňku můžete obdržet oznámení vyvolání až IDTCommandTarget rozhraní.Tlačítko můžete přidat pomocí OnConnection metoda IDTExtensibility2 rozhraní.
Příklady
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
Zabezpečení rozhraní .NET Framework
- Plná důvěra přímému volajícímu. Částečně zabezpečený kód nemůže tento člen použít. Další informace naleznete v tématu Používání knihoven z částečně důvěryhodného kódu.