API Explorer - модуль исследования объектов TechnologiCS API. Его основная цель, получить список свойств активного модуля и примеры использования отдельных сложных методов для использования их при написании собственных программ.

Для его вызова используется кнопка «API Explorer»  на панели управления.

При запуске API Explorer для исследования открывает объект модуля TechnologiCS API, из которого был открыт редактор.

Основная задача API Explorer - получение информации о свойствах исследуемого модуля. В процесс работы часто возникает потребность узнать название того или иного модуля, посмотреть значение его свойства или тип, попробовать промоделировать ситуацию получения ряда свойств (актуально для свойств типа ptModule).

В главном окне модуля находится ряд закладок, соответствующих основным интерфейсам TechnologiCS (именно с методами этих интерфейсов идет основная работа):

·         Закладка «Full View»

·         Закладка «IModule»

·         Закладка «IPModule»

·         Закладка «IDModule»

·         Закладка «IGModule»

·         Закладка «Log»

·         Закладка «Application»

Full View

Данная закладка является сервисным режимом, в котором можно отобразить содержимое  сразу всех закладок (в основном) в одном окне.

IModule

·         Закладка «IModule» - «IModule» - перечислены методы интерфейса IModule (см. IModule в TechnologiCS API) и их значение для данного модуля.

·         Закладка «IModule» - «IModule. Установленный флаг «IsChildModule» означает, что для данного объекта нет соответствующего интерфейса и создан по умолчанию интерфейс от ChildModules.

IPModule

·         Закладка «IPModule»  - «IPModule» - отображает информацию о доступных действия с данными интерфейса IPModule.

 На панели инструментов доступны кнопки для вызовы некоторых процедур интерфейса, например: BeginUpdate, EndUpdate, SaveChages, CancelChages (см. описание интерфейса IPModule в TechnologiCS API). Нажимая их, мы фактически производим вызов данного метода у текущего модуля, при этом на закладке «Log» - логируется последовательность вызовов.

При нажатии кнопки  «CreateNew», отображается форма ввода, в которой можно заполнить доступные для добавления свойства  и получить код для добавления записи в текущий модуль (при этом используются заполненные вами значения).

·         Закладка «IPModule» - «Properties» - отображает список свойств интерфейса.

На доп. закладках «IProp» и «IProp отображаются характеристики выбраного свойства.

При нажатии кнопки  «Properties», обновляется список свойств (это просто служебная  функция, она не вызовет никаких отражений в логе).

Двойным нажатием левой клавиши мыши можно скопировать имя свойства в лог.

Если свойство имеет тип ptModule, то, нажав кнопку AsIDispatch, мы попадем в новое окно API Explorer, где будем исследовать уже полученное свойство. По завершению работы с ним мы можем так же сохранить всю работу с ним в текущем логе.

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

IDModule

·         Закладка «IDModule» - «IDModule» - отображает список методов интерфейса IDModule (см. IDModule в TechnologiCS API).

·         Закладка «IDModule» - «ChildModules»

·         Закладка «IDModule» - «ActionList»

IGModule

·         Закладка «IGModule» - «ICsdnAxDbGrid» - отображает список методов интерфейса IGModule (см. IGModule в TechnologiCS API).

·         Закладка «IGModule» - «IGModule»

Log

На данной закладке протоколируются вся работа в процессе исследования свойств в API Explorer Данный протокол может быть занесен в буфер обмена для последующей вставки в текст модуля.

Application

На данной закладке можно увидеть и исследовать справочники и их свойства.

Нажав на кнопку  «Explore This Module» мы попадем в API Explorer для выделенного модуля (справочника) и сможем исследовать его свойства.

 


См. также:

18 Макросы и скриптовые модули