Пишем подключаемый модуль на C#

У начинающих разработчиков часто появляются вопросы, как написать плагин к ЛОЦМАН Клиент на C#.

Основные проблемы составляет следующее:

• Как экспортировать из сборки функции InitUserDLLCom, PgiCheckMenuItemCom и другие?
• Как получить описания интерфейсов клиентского приложения?
• Как реализовать функцию InitUserDLLCom?
• Как разместить сборку и ее зависимости в отдельной папке?
• Как добавить значки для пунктов меню?

Подробнее об этом ниже.

Подключаемые модули в версии 2017

Версия «ЛОЦМАН:PLM 2017» принесла новые изменения в работу подключаемых модулей.

Теперь есть три варианта клиентских лицензий: Базовая, Стандартная и Максимальная. Тип лицензии определяет набор функций, которые будут доступны в клиентском приложении. В том числе использование подключаемых модулей:

• Для базовой лицензии использование подключаемых модулей недоступно.
• Для стандартной лицензии необходимо приобретение дополнительной опции «Использование расширений».
• Для максимальной лицензии нет ограничений.

Подключаемые модули в новых версиях ЛОЦМАН Клиент

Для разработчиков плагинов в новых версиях 13 и 14 комплекса произошли заметные изменения (под версиями 13 и 14 здесь подразумевается «Комплекс решений АСКОН 2013» и «Комплекс решений АСКОН 2014»).

Положительная сторона изменений в том, что API плагинов теперь документирован (см. LoodsmanClientApi.chm) и предоставляет разработчику больше возможностей. Из недостатков стоит отметить несовместимость API со старыми версиями плагинов, и даже между 13 и 14 версиями. И документации мало, и местами она не соответствует реальному положению дел. И баги в IDataSet... Но не будем о грустном.

GitHub

Исходный код примера подключаемого модуля из статьи Пишем подключаемый модуль для ЛОЦМАН Клиент и исходный код IRemoteConnection теперь доступны на GitHub — github.com/achechulin/loodsman.

Текущую версию кода можно скачать без клиента Git или SVN, нажав кнопку «Download ZIP» в правой части страницы репозитория.

Пишем подключаемый модуль для ЛОЦМАН Клиент

Подключаемый модуль (плагин) для ЛОЦМАН Клиент предназначен для добавления новых функций в клиентское приложение.

Снаружи подключаемый модуль выглядит как несколько пунктов в меню клиентского модуля. Начиная с версии 10, эти пункты меню могут быть добавлены в контекстное меню и на панели инструментов.

Внутри подключаемый модуль — это DLL, реализующая специальные функции. Есть два основных вида интерфейсов для взаимодействия подключаемого модуля с клиентом Лоцман: PAS-интерфейс и COM-интерфейс. Описание PAS-интерфейса отсутствует в официальной документации, не рекомендовано к использованию и создает множество проблем при использовании новых версий Delphi, поэтому мы будем писать подключаемый модуль с COM-интерфейсом. Описание его вы найдете в папке SDK дистрибутива в файле LoodsmanClientApi.chm.

Подключаемые модули для ЛОЦМАН Клиент

Подключаемые модули предназначены для расширения возможностей клиентского модуля ЛОЦМАН:PLM. Например, модуль «Извещения» из стандартной поставки добавляет функции по созданию, согласованию и проведению извещений.

С точки зрения пользователя подключаемый модуль выглядит как несколько пунктов в главном меню клиентского модуля. Начиная с версии 10, эти пункты меню могут быть добавлены в контекстное меню и на панели инструментов.