Введение в строение конфигурационного файла. Компоненты.

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

Само приложение может содержать множество компонентов и все компоненты должны быть описаны в конфигурационном XML файле. Такой файл лучше открыть с помощью редактора поддерживающего XML синтаксис или любым текстовым редактором, желательно поддерживающем кодировку UTF-8. Подойдет и Блокнот, только при сохранении файла под другим именем в диалоге Файл/Сохранить как... нужно указать Тип файла "Все файлы (*.*)", иначе Блокнот автоматически добавить расширение .txt. Настоятельно рекомендую сохранить резервную копию конфигурационного файла. Конфигурационных файлов для приложения может быть несколько, в этом случае необходимо указать дополнительный параметр при загрузке приложения -config:<Имя конфигурационного файла>.

Итак, вы сохранили резервную копию и теперь можно открыть конфигурационный файл для более детального рассмотрения. Если вы знакомы с XML-синтаксисом переходите к следующему абзацу, для остальных кратко: XML— это описанная в текстовом формате иерархическая структура, предназначенная для хранения любых данных. Визуально структура может быть представлена как дерево элементов. Элементы XML описываются тегами. Каждый элемент может содержать именованные атрибуты и содержимое. Элемент обычно состоит из открывающего и закрывающего тегов, обрамляющих текст и другие элементы. Открывающий тег состоит из имени элемента в угловых скобках, например, <step>, а закрывающий тег состоит из того же имени в угловых скобках, но перед именем ещё добавляется косая черта, например, </step>. Содержимым элемента называется всё, что расположено между открывающим и закрывающим тегами, включая текст и другие (вложенные) элементы.

Не все элементы описанные в конфигурационном файле должны быть обязательно загружены. Некоторые можно отключать, это может быть иногда удобно. Для этого все элементы можно разбить на именованные группы и в конфигурационном файле указать какие группы вы хотите задействовать. Для этого обычно где-то вначале файла создается элемент <components> в котором перечислены задействованные группы компонентов в виде элементов <component>Имя группы</component> у которых содержимое является именем группы. Для указания, что данный элемент в конфигурационном файле относится к группе необходимо добавить к нему атрибут _component_dependent="Имя группы"

Будем считать, что с группами мы разобрались. Перейдем к самому важному для нас. Все компоненты в конфигурационном файле описываются элементом
<object name="Имя объекта" clsid="Программный идентификатор" description="Описание компонента"...>
</object>
Здесь указаны обязательные атрибуты "Имя объекта" - по этому имени этот компонент будет доступен из скриптов. "Программный идентификатор" - название класса компонента, все API привязаны именно к данному классу. Доступ к приложению из скриптов должен начинаться с объекта Application, за которым через точку идет имя объекта указанное в конфигурационном файле. Далее я расскажу о доступных свойствах и функциях (API) для наиболее востребованных классов, которые вы сможете использовать в своих скриптах.