Обзор и настройка системы сценариев

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

Редактор скриптов, отладчик и панели скриптинга работают совместно, помогая вам легко писать и отлаживать скрипты. Скрипт можно запускать напрямую из редактора скриптов или назначить его на меню, панель инструментов либо горячую клавишу, чтобы в любой момент применять его к текущему документу — например, к PCB Layout.

Altium Designer с окнами Script Code и Form, а также панелями Object Inspector, Code Explorer и Tool Palette .

Возможности системы скриптинга

Система скриптинга состоит из двух основных частей — редактора и отладчика. Основные возможности:

• Project access – Скрипты можно сохранять в скриптовом или проекте разработки. Процедуры из любого скрипта в проекте доступны другим скриптам в рамках того же проекта.

• Scripting Editor – Редактор скриптинга включает специализированный текстовый редактор с набором параметров для настройки среды редактирования и подсветки синтаксиса.

• Scripting Panels – Система скриптинга содержит ряд панелей, которые помогают быстро писать код и отлаживать скрипты.

• Scripting Debugger – Если при выполнении скрипта возникает ошибка, появляется диалоговое окно с кратким сообщением об ошибке. Вы можете просматривать переменные в окне Watches, трассировать код и управлять выполнением скрипта с помощью Script Debugger.

• Scripting Languages – Скрипты можно создавать на DelphiScript и, если включено как устаревший язык, на VBScript.

Модули и формы скриптов

Скриптовые проекты поддерживают два типа скриптовых документов — Script Units и Script Forms. Script Units позволяют писать автономные процедуры и функции. Script Forms позволяют создавать диалоги с элементами управления и обработчиками событий, а также процедурами и функциями.

• Script Unit может использовать интерфейс X2 Application Programming Interface (API) для изменения или манипулирования объектами проекта в документе разработки. Script Form размещает элементы управления как пользовательский интерфейс и использует X2 API для предоставления диалогов скрипта, которые воздействуют на активные документы разработки.
• Script Form — это визуальный модуль формы, поддерживаемый скриптом. Когда форма активна, она представляет собой диалоговое окно.
• Script Form имеет два представления — Script Code и Script Form. Представление Script Code содержит обработчики событий и процедуры/функции. Представление Script Form отображает диалоговую форму (разных типов) и содержит элементы управления вместе с соответствующими обработчиками событий.
• Script Form имеет два связанных файла. Файл *.pas содержит обработчики событий и процедуры/функции, а файл *.dfm содержит сведения о самой форме скрипта, а также о её компонентах и их расположении.
• Компонент — это визуальный или невизуальный объект управления (размещаемый с панели Tool Palette panel), который принимает ввод от пользователя, например щелчок мышью или последовательность введённых символов. Во время проектирования панель Object Inspector panel можно использовать для управления компонентами на Script Form. Компоненты можно использовать в любой Script Form на любом наборе языков, поддерживаемом системой скриптинга.
• Компонент (объект управления) имеет методы, свойства и события, которые могут использоваться Script Form.
  • Методы — это действия, которые объект может выполнять.
  • Свойства представляют данные, содержащиеся в объекте, к которым можно получить доступ или которые можно изменить.
  • События — это условия, на которые может реагировать компонент на Script Form.
• Script Form имеет обработчики событий, которые обрабатывают зафиксированные условия, например нажатие кнопки на форме.

Примеры скриптов Altium Designer

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

Запуск примера

Чтобы быстро запустить пример скрипта в Altium Designer, сначала откройте пример проекта или отдельный файл скрипта из одной из папок с примерами — например, простой проект «Hello World» (HelloWorld.PRJSCR) из папки Scripts\Delphiscript Scripts\General.

Проект DelphiScript Hello World открыт в панели Projects .

Проект содержит две версии скрипта «Hello World», где вторая (HelloWorlDialog.pas) демонстрирует базовое использование модуля Form. Дважды щёлкните имя скрипта, чтобы открыть и изучить его в редакторе — обратите внимание, что скрипт можно запускать, даже если он не открыт в редакторе.

Чтобы запустить один из скриптов, выберите File » Run Script в главном меню, затем выберите доступную процедуру скрипта в диалоге Select Item To Run. При запуске версии откроется диалоговое окно с сообщением.

Быстрый и простой способ запустить пример скрипта.

Настройка системы скриптинга

Preferences

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

Общие настройки

Страница Text Editors – General диалога Preferences позволяет настроить требования к редактированию скриптов, такие как поведение поиска строк, табуляция и отступы строк, назначение клавиш и ряд других расширенных параметров.

Страница Text Editors – General диалога Preferences

Настройки цветов

Страница Text Editors – Colors диалога Preferences позволяет настроить подсветку синтаксиса в Script Editor для выбранного языка скриптинга, а также задать цвета элементов в редакторе скриптов. Например, чёрный для фона, белый для ключевых слов комментариев и т. д.

Страница Text Editors – Colors диалога Preferences

Настройки отображения

Страница Text Editors – Display диалога Preferences позволяет настроить визуальные особенности скриптов, такие как отображение правых полей и номеров строк, подсветка синтаксиса и сворачивание/структурирование кода.

Страница Text Editors – Display диалога Preferences

Глобальные настройки проектов

Страница Scripting System – Global Projects диалога Preferences содержит список доступных (установленных) скриптовых проектов. Скриптовые проекты можно устанавливать, удалять или менять их порядок.

Страница Scripting System – Global Projects диалога Preferences

Настройки конструктора форм

Страница Scripting System – Form Designer диалога Preferences предоставляет параметры сетки и обозначений компонентов для документа формы скриптинга.

Страница Scripting System – Form Designer диалога Preferences