ADN Open CIS
Сообщество программистов Autodesk в СНГ

Программный запуск пользовательской внешней команды

Программный запуск пользовательской внешней команды

Одним из ключевых нововведений в Revit API 2014 является появление метода PostCommand, позволяющего программно выполнить стандартные встроенные команды Revit.

В примерах из Revit SDK есть проект PostCommandWorkflow, демонстрирующий работу нового метода.

Однако, с помощью этого метода можно выполнить только встроенную команду Revit. Запустить внешнюю команду созданную в сторонней надстройке, выполнить с помощью этого метода не получится.

К счастью, эта проблема была исправлена в обновлении Update Release 1 и среди улучшений в Revit API Update Release 1 можно увидеть следующее:

• В методе UIApplication.PostCommand() разрешена работа с командами, созданными во внешних надстройках.

Так как же мы можем использовать эту функциональность?

Ниже представлен вопрос и мое пояснение от нового Revit разработчика.

Программный запуск внешней команды

Вопрос: В метод PostCommand из Revit API требуется передать RevitCommandId в качестве параметра.

Я попытался получить идентификатор команды с помощью метода LookupCommandId, передав ему название класса моей внешней команды, но безуспешно. Метод не возвратил ничего.

Я также посмотрел файл журнала, после того, как я запустил команду из пользовательского интерфейса и попробовал передать различные варианты имени команды, которые я увидел в журнале.

• "Execute external command:CustomCtrl_%CustomCtrl_%NTItools%Parameters%Door Tool:SwingTool.DoorCommandLogger"
• "CustomCtrl_%CustomCtrl_%NTItools%Parameters%Door Tool:SwingTool.DoorCommandLogger"

По-прежнему метод не возвратил мне идентификатор моей команды.

Так как же можно выполнить пользовательскую команду?

Ответ: Давайте начнем с того, что более детально посмотрим на пример PostCommandWorkflow из SDK и на классы, которые там используются.

Вот код, который используется для запуска команды:

В этом коде много строк, которые нам не важны в данный момент.

На самом деле, нам интересны всего лишь две строчки – вызов методов LookupPostableCommandId и PostCommand.

Метод LookupPostableCommandId принимает перечисление типа PostableCommand и возвращает объект типа RevitCommandId. Этот объект необходимо передать в метод PostCommand.

Класс  RevitCommandId хранит в себе идентификатор команды и ее наименование.

В случае с командой SheetIssuesOrRevisions, которая используется в примере, идентификатор и наименование выглядят вот так:

• Id = 3153
• Name = "ID_SETTINGS_REVISIONS"

Вы с легкостью можете увидеть эти значения в отладчике Visual Studio, реализовав внешнюю команду с вот таким простым выражением:

Как мы видим, встроенные команды Revit мы можем выполнить и получить их список в перечислении PostableCommand. Также мы можем воспользоваться методом LookupPostableCommandId, чтобы получить подходящий объект класса RevitCommandId, необходимый для программного выполнения команды.

Однако, пользовательские команды, определенные во внешних надстройках, очевидно не будут включены в этот список. Давайте разберемся, что мы можем придумать в этом случае.

Я изучил документацию по Revit API для этих классов и нашел следующее утверждение:

Класс RevitCommandId представляет собой идентификатор команды в Autodesk Revit. Каждая команда в Revit имеет числовой идентификатор и нелокализованное наименование. Этот класс позволяет найти команду по ее имени и представляет собой команду, которую необходимо использовать в методе AddInCommandBinding.

Это все хорошо, но как мы можем это использовать?

LookupPostableCommandId метод принимает перечисление в качестве параметра и для пользовательских команд подходящего перечисления нет.

Но, класс RevitCommandId имеет аж два статических метода: LookupPostableCommandId и LookupCommandId.

Первому методу необходимо передать одно из значений перечисления PostableCommand, тогда как второму методу достаточно указать лишь название команды в виде строки. Документация по последнему методу говорит нам следующее:

Вы можете использовать метод RevitCommandId.LookupCommandId для того чтобы получить соответствующий идентификатор команды Revit по заданной строке. Чтобы узнать название команды, можно посмотреть в файл журнала и найти там строку, соответствующую названию выполняемой команды.

Таким образом, нужно проделать то, что вы уже пробовали и описали в своем вопросе:

• Создать простую ничего не делающую команду. Назовем ее CmdDummy к примеру.
• Запустить команду из интерфейса Revit
• Найти строки, в файле журнала, содержащие текст «Dummy»

Вот такие строки я нашел в файле журнала после выполнения команды:

C:\Users\tammikj\AppData\Local\Autodesk\Revit\Autodesk Revit 2014\Journals > grep -i dummy journal.0242.txt

' 0:< Added new API pushbutton 35024, name PostAddinCommand Dummy Command, class PostAddinCommand.CmdDummy, assembly PostAddinCommand.dll, vendorId TBC_, vendor description The Building Coder, http://thebuildingcoder.typepad.com.

' 4:< MasterLocks 0x0000000014BB1250 DummyStorage stole m_oDataStorage 0x0000000014C52950 but left m_pDataStorage 0x0000000014C52950

Jrn.RibbonEvent "Execute external command:64b3d907-37cf-4cab-8bbc-3de9b66a3efa:PostAddinCommand.CmdDummy"

' 0:< DummyStorage destroying DataStorageInterface 0x0000000014C52950

Исключив все строки со словом Dummy, которые возможно не были созданы после выполнения команды, остается только одна подходящая строка, где содержится наименование команды:

Jrn.RibbonEvent "Execute external command:64b3d907-37cf-4cab-8bbc-3de9b66a3efa:PostAddinCommand.CmdDummy"

GUID, который стотит перед названием команды 0 это GUID, который я указал в файле манифеста моей надстройки.

В первой попытке я попробовал передать в метод LookupCommandId и название и идентификатор как они написаны в файле журнала:

"64b3d907-37cf-4cab-8bbc-3de9b66a3efa:PostAddinCommand.CmdDummy"

Попытка оказалась неудачной и метод вернул null.

В следующей попытке я передал только GUID. На этот раз меня настигла удача.

Ниже представлен код моей команды, в которой я успешно программно запускаю выполнение другой своей команды.

Числовой идентификатор моей команды равен 35024, а название – это просто GUID моей команды.

Числовой идентификатор так же виден в файле журнала, когда создалась кнопка для запуска команды.

Полный исходный код примера для Visual Studio можно скачать из репозитория на GitHub.

 

Программный запуск команды, вызывающейся по кнопке на ленте

Мы уже знаем, как программно запустить команду, которая описана в файле манифеста. Нам нужно использовать GUID этой команды.

Однако более менее серьезные приложения не описывают команды явно в файле манифеста, так как это не очень удобно для пользователя запускать команды на вкладке Надстройки -> Внешние инструменты.

Фактически существуют два совершенно различных тип внешних команд, которые реализуют интерфейс  IExternalCommand:

• Внешняя команда описана в файле манифеста, которую можно выполнить из вкладки Надстройки -> Внешние инструменты
• Команда выполняется с помощью кнопки, созданной во внешнем приложении.

Последний вариант не имеет GUID.

Тем не менее, чтобы получить наименование такой команды, нужно проделать те же самые шаги и найти в файле журнала соответствующее наименование.

Я реализовал новую внешнюю команду CmdDummy2 чтобы протестировать случай, когда выполнение команды осуществляется с помощью кнопки. Кнопку я создаю в методе OnStartup класса приложения.

Повторяя шаги, описанные выше, где я вручную запускаю команду в интерфейсе, а затем ищу подходящие строки в файле журнала, я получил следующее:

c:\Users\tammikj\AppD

' 0:< Added new API pushbutton 6417 name  text Dummy2 class PostAddinCommand.CmdDummy2 assembly C:\Users\tammikj\AppData\Roaming\Autodesk\Revit\Addins\2014\PostAddinCommand.dll

 Jrn.RibbonEvent "Execute external command:CustomCtrl_%CustomCtrl_%Add-Ins%Post Add-in Command%Dummy2:PostAddinCommand.CmdDummy2"

' 1:< TaskDialog "Hello from CmdDummy2!"

Наименование команды в этом случае выглядит более длинным:

"CustomCtrl_%CustomCtrl_%Add-Ins%Post Add-in Command%Dummy2"

Как можно заметить строка представляет собой иерархический список разделенный знаком %

Первые два пункта списка фиксированы и являются константой CustomCtrl_

Последние три – это последовательность элементов на ленте, по которым пользователь должен пройтись, чтобы запустить команду. В нашем случае это стандартная вкладка Надстрйоки, панель на ленте "Post Add-in Command", которую я создал, и текст кнопки на этой панели – Dummy2.

Несмотря на то что название команды выглядит громоздким, в этом есть некоторое преимущество. Зная алгоритм формирования названия, мы можем получить название команды не заглядывая в файл журнала.

Следующий код без каких-либо проблем возвращает мне RevitCommandId для моей команды и программно  ее запускает.

Пошагово выполняя этот код в отладчике и просматривая свойства объекта класса RevitCommandId , я вижу, что числовой идентификатор команды равен 6417.

Тот же самый номер я видел и в файле журнала при создании кнопки.

Если же вы посмотрите на числовые идентификаторы каждой встроенной команды, полученной с помощью LookupPostableCommandId, то вы можете увидеть, что этот идентификатор совпадает с числовым значением перечисления PostableCommand.

Исходя из этого, я подумал, что может быть возможнопривести числовой идентификатор к типу перечисления PostableCommand и использовать метод  LookupPostableCommandId вместо поиска наименований команд.

Однако, это не сработало. Я получал исключения: «Неверное значение PostableCommand».

Примечание переводчика. На самом деле нет смысла использовать числовое значение команды, так как возможно оно будет различно у каждого пользователя, в зависимости от количества установленных внешних приложений и количества команд в них. Использовать наименования гораздо надежнее.

Источник: http://thebuildingcoder.typepad.com/blog/2013/10/programmatic-custom-add-in-external-command-launch.html