IDTCommandTarget.QueryStatus - метод

Статья
11/05/2008

Обновлен: Ноябрь 2007

Возвращает текущее состояние (включена, отключена, скрыта и т. д) указанной именованной команды.

Пространство имен: EnvDTE
Сборка: EnvDTE (в EnvDTE.dll)

Синтаксис

'Декларация
Sub QueryStatus ( _
    CmdName As String, _
    NeededText As vsCommandStatusTextWanted, _
    <OutAttribute> ByRef StatusOption As vsCommandStatus, _
    <OutAttribute> ByRef CommandText As Object _
)
'Применение
Dim instance As IDTCommandTarget
Dim CmdName As String
Dim NeededText As vsCommandStatusTextWanted
Dim StatusOption As vsCommandStatus
Dim CommandText As Object

instance.QueryStatus(CmdName, NeededText, _
    StatusOption, CommandText)

void QueryStatus(
    string CmdName,
    vsCommandStatusTextWanted NeededText,
    out vsCommandStatus StatusOption,
    out Object CommandText
)

void QueryStatus(
    [InAttribute] String^ CmdName, 
    [InAttribute] vsCommandStatusTextWanted NeededText, 
    [InAttribute] [OutAttribute] vsCommandStatus% StatusOption, 
    [InAttribute] [OutAttribute] Object^% CommandText
)

function QueryStatus(
    CmdName : String, 
    NeededText : vsCommandStatusTextWanted, 
    StatusOption : vsCommandStatus, 
    CommandText : Object
)

Параметры

CmdName
Тип: System.String
Имя команды, которую требуется проверить.

NeededText
Тип: EnvDTE.vsCommandStatusTextWanted
Константа vsCommandStatusTextWanted, указывающая, возвращаются ли данные из проверки, и если возвращаются, то каков тип возвращаемых данных.

StatusOption
Тип: EnvDTE.vsCommandStatus%
vsCommandStatus , определяющая текущее состояние команды.

CommandText
Тип: System.Object%
Текст, который возвращается, если указан vsCommandStatusTextWantedStatus.

Заметки

В следующем примере используется объект Command и его методы AddNamedCommand и AddControl, а также интерфейс IDTCommandTarget (с двумя своими методами Exec и QueryStatus). В примере показано, как включить надстройку в виде команды в меню Сервис среды Visual Studio. Обратите внимание, что этот код не работает в составе макроса.

Примеры

Implements IDTCommandTarget

Dim applicationObject As EnvDTE.DTE
Dim addInInstance as EnvDTE.AddIn
   
Dim objAddIn As AddIn = CType(addInInst, AddIn)
Dim CommandObj As Command
Try
   CommandObj = applicationObject.Commands.AddNamedCommand(objAddIn, "MyAddin1", "MyAddin1", "Executes the command for MyAddin1", True, 59, Nothing, 1 + 2)
   '1+2 == vsCommandStatusSupported+vsCommandStatusEnabled
   CommandObj.AddControl(applicationObject.CommandBars.Item("Tools"))
Catch e as System.Exception
End Try

Public Sub Exec(ByVal cmdName As String, ByVal executeOption As vsCommandExecOption, ByRef varIn As Object, ByRef varOut As Object, ByRef handled As Boolean) Implements IDTCommandTarget.Exec
   handled = False
   If (executeOption = vsCommandExecOption.vsCommandExecOptionDoDefault) Then
      If cmdName = "MyAddin1.Connect.MyAddin1" Then
         handled = True
         Exit Sub
      End If
   End If
End Sub
   
Public Sub QueryStatus(ByVal cmdName As String, ByVal neededText As vsCommandStatusTextWanted, ByRef statusOption As vsCommandStatus, ByRef commandText As Object) Implements IDTCommandTarget.QueryStatus
   If neededText = EnvDTE.vsCommandStatusTextWanted.vsCommandStatusTextWantedNone Then
      If cmdName = "MyAddin1.Connect.MyAddin1" Then
         statusOption = CType(vsCommandStatus.vsCommandStatusEnabled & vsCommandStatus.vsCommandStatusSupported, vsCommandStatus)
      Else
         statusOption = vsCommandStatus.vsCommandStatusUnsupported
      End If
   End If
End Sub

Разрешения

Полное доверие для непосредственно вызывающего метода. Этот член не может быть использован частично доверенным кодом. Дополнительные сведения см. в разделе Использование библиотек из не вполне надежного кода.

См. также

Ссылки

IDTCommandTarget Интерфейс

IDTCommandTarget - члены

EnvDTE - пространство имен

Поделиться через