Просмотр исходного текста страницы Структура интерфейса

[[Встраиваемые_plugin-модули|Наверх]]

В главной сборке plugin-программы приложением Oktell ищется класс, реализующий нижеприведенный перечень методов. Если при подключении возникают проблемы с сопоставлением, модуль регистрации plugin-программы подскажет, что именно и в каком методе не подходит и не соответствует ожидаемому интерфейсу.

Даже если plugin-программа не использует часть возможных механизмов и не заявляет об их использовании в возвращаемых значениях существующих для этого методов, для ее регистрации необходимо наличие и соответствие всех заявленных в интерфейсе методов. Так, если plugin-программа служит только для отображения форм в разделе внешних модулей, в ее управляющем объекте в любом случае должны присутствовать методы (заглушки в данном случае) для работы с диалоговыми формами.

Возможны варианты использования plugin-программ, осуществляющих невизуальную фоновую деятельность, или деятельность не связанную с режимами диалоговых сценариев и/или работы внешних модулей. В этом случае чаще всего требуется загрузка плагина на старте клиентского приложения. Момент загрузки настраивается администратором при регистрации plugin-программы в Oktell. Стоит отметить, что в этом случае в момент загрузки будет выполнен конструктор, а также метод '''DoQuery''' с функцией [[Сервисное взаимодействие|pluginloaded (20401)]]. Без особой на то необходимости рекомендуется запускать внутренние объекты именно в реализации указанной функции метода '''DoQuery''', а не в конструкторе, так как конструктор вызывается в любом случае, даже если plugin-программа подгружается в административных целях.

В этой статье приведен перечень методов, свойств и событий.

В [[Описание базовых элементов интерфейса|следующей статье]] будет структурное описание назначения всех методов.

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


==Методы, необходимые для соответствия интерфейсу==

:<span style="color:blue">delegate string</span> PluginQueryInvoker ( <span style="color:blue">string</span> xml );
:
:Guid GetId ( );
:<span style="color:blue">int</span> GetInterfaceVersion ( int lastknownversion );
:<span style="color:blue">string</span> GetModuleVersion ( );
:<span style="color:blue">string</span> GetModuleName ( );
:<span style="color:blue">string</span> GetDBUpdate ( );
:<span style="color:blue">string</span> GetForms ( );
:
:<span style="color:blue">string</span> GetInputParams ( <span style="color:blue">string</span> xml );
:<span style="color:blue">string</span> GetOutputParams ( <span style="color:blue">string</span> xml );
:<span style="color:blue">string</span> ShowDesign ( <span style="color:blue">string</span> xml );
:<span style="color:blue">string</span> PrepareShow ( <span style="color:blue">string</span> xml );                
:<span style="color:blue">string</span> GetCurrentFillInfo ( <span style="color:blue">string</span> xml );
:<span style="color:blue">string</span> StopShow ( <span style="color:blue">string</span> xml );
:<span style="color:blue">string</span> GetControlResult ( <span style="color:blue">string</span> xml );

System.Windows.Forms.Control CreateControl ( <span style="color:blue">string</span> xml );

<span style="color:blue">event</span> PluginQueryInvoker OnQuery;
<span style="color:blue">string</span> DoQuery ( <span style="color:blue">string</span> xml );