脚本系统的概述和设置

Altium Designer 脚本系统提供创建脚本所需的所有工具和功能,可自动执行软件中的任务。

脚本编辑器、调试器和脚本面板协同工作,帮助您轻松编写和调试脚本。脚本可以直接从脚本编辑器运行,也可以分配给菜单、工具栏或热键,以便随时应用于当前文档(如 PCB 布局)。

Altium Designer 显示的脚本代码和窗体窗口带有 Object Inspector, Code Explorer和 Tool Palette 面板的脚本代码和窗体窗口。
Altium Designer 显示的脚本代码和窗体窗口带有 Object Inspector, Code ExplorerTool Palette 面板的脚本代码和窗体窗口。

脚本系统功能

脚本系统由编辑器和调试器两大部分组成。主要功能如下:

  • Project access- 脚本可保存在脚本或设计项目中。同一项目中的其他脚本可以访问项目中任何脚本的例程。

  • Scripting Editor- 脚本编辑器是一个专用的文本编辑器,提供一系列选项来设置编辑环境和语法着色。

  • Scripting Panels- 脚本系统还具有大量面板,可帮助您快速编码和调试脚本。

  • Scripting Debugger- 如果脚本在执行过程中出现错误,就会出现一个对话框,其中包含简明的错误信息。您还可以在 "观察 "窗口中预览变量,跟踪代码,并使用脚本调试器控制脚本的执行。

  • Scripting Languages- 脚本可以用 DelphiScript 创建,如果启用传统语言,也可以用 VBScript 创建。

  • 默认脚本语言设置为 DelphiScript。您可以打开并运行以 VBScript 和 JavaScript (Jscript) 编写的现有脚本。要创建以 VBScript 编写的新脚本,必须在高级设置对话框中启用 Legacy.Scripts.SupportOldLanguages选项。

  • 有关脚本 API 的文档,请点击此处:脚本 API 对象。请注意,此文档最后一次更新是针对 Altium Designer 的旧版本。虽然许多原则和方法保持不变,但请注意,接口、对象、方法、属性等自更新以来已发生变化,并不能反映软件后续版本中的全部内容。

脚本单元和表单

脚本项目支持两种脚本文档类型--脚本单元和脚本表单。脚本单元允许你编写独立的程序和函数。脚本窗体允许你创建带有控件和事件处理程序以及程序和函数的对话框。

  • 脚本单元可以使用 X2 应用程序编程接口(API)来修改或操作设计文档中的设计对象。脚本窗体承载控件作为用户界面,并利用 X2 应用程序接口提供脚本对话框,在活动设计文档上执行操作。
  • 脚本窗体是脚本支持的可视化窗体单元。当窗体处于活动状态时,它代表一个对话窗口。
  • 脚本窗体有两个视图--脚本代码视图和脚本窗体视图。脚本代码视图包含事件处理程序和过程/函数。脚本窗体 "视图代表对话窗体(不同类型),包含控件及其相关事件处理程序。
  • 脚本窗体有两个相关文件。A *.pas文件包含事件处理程序和过程/函数,另一个 *.dfm文件,该文件包含脚本表单本身及其组件和位置的详细信息。
  • 组件是一个可视或非可视的控制对象(从工具调板面板上放置),可接受用户的输入,如鼠标点击或输入的字符序列。在设计过程中,可以使用 "对象检查器"面板来操作脚本窗体上的组件。这些组件可以在脚本系统支持的任何语言集的任何脚本窗体中使用。
  • 组件(控制对象)具有可用于脚本窗体的方法、属性和事件。
    • 方法是一个对象可以执行的操作。
    • 属性代表对象中包含的可访问或修改的数据。
    • 事件是脚本表单中的组件可以做出反应的条件。
  • 脚本表单中的事件处理程序可以处理捕捉到的条件,如点击表单按钮时。

脚本文档主要侧重于 DelphiScript 语言集。DelphiScript 语言集基于 Embarcadero DelphiScript 技术。有关 DelphiScript 与 Object Pascal(在 Delphi 中使用)之间的区别,请参阅DelphiScript参考文档。

Altium Designer 脚本示例

示例和参考脚本是了解脚本中如何应用对象接口、方法、流程、属性和组件的有用资源。它们还可用作您自己脚本项目的基础。

在此处下载 Altium Designer 10 发布时构建的传统参考设计。其中包括大量仿真和脚本示例。请注意,这些都是旧版本,不会更新。
有关其他脚本示例的信息,请参阅《脚本示例参考》。有关在 Altium Designer 中使用脚本示例的实用说明,请参阅编写脚本脚本示例分析

运行示例

要在 Altium Designer 中快速运行脚本示例,首先打开一个示例项目或示例脚本文件夹中的单个脚本文件,例如,从 "脚本示例 "文件夹中打开简单的 "Hello World "项目 (HelloWorld.PRJSCR) 文件夹中的 Scripts\Delphiscript Scripts\General文件夹中的简单 "Hello World "项目 ( )。

脚本示例将在解压缩后的下载文件夹中提供。

DelphiScript Hello World 项目在 Projects 面板中打开。
DelphiScript Hello World 项目在 Projects 面板中打开。

该项目包含两个版本的 "Hello World "脚本,其中第二个版本 (HelloWorlDialog.pas) 演示了窗体单元的基本用法。双击脚本名称可在编辑器中打开并检查该脚本--请注意,脚本可以在编辑器中未打开的情况下运行。

要运行其中一个脚本,从主菜单中选择 File » Run Script对话框中选择一个可用的脚本过程。 Select Item To Run对话框中选择一个可用的脚本程序。当运行一个版本时,将打开一个对话框显示信息。

运行示例脚本的快速简单方法。运行示例脚本的快速简单方法。

脚本系统设置

首选项

脚本系统的默认首选项设置可在首选项对话框中进行配置,点击设计空间右上方的 控制按钮即可进入该对话框。

常规首选项

文本编辑器 - 常规页面的 Preferences对话框的 "文本编辑器"- 常规页面允许您设置脚本编辑要求,如字符串搜索行为、行的制表符和缩进方式、按键映射方式以及其他一些高级选项。


对话框的 Text Editors – General 页面 Preferences对话框

颜色首选项

文本编辑器 - 颜色页面的 Preferences 对话框的 "文本编辑器 - 颜色 "页面允许您为所选脚本语言配置脚本编辑器的语法着色,并设置脚本编辑器中元素的颜色。例如,背景为黑色,注释关键字为白色,等等。

脚本编辑器的 Text Editors – Colors页面的 Preferences对话框
脚本编辑器的 Text Editors – Colors页面的 Preferences对话框

显示首选项

文本编辑器 - 显示页面的 Preferences 对话框可以配置脚本的可视化功能,如显示右边距和行号、语法高亮显示和代码大纲。

该 Text Editors – Display页面的 Preferences对话框
Text Editors – Display页面的 Preferences对话框

全局项目首选项

脚本系统 - 全局项目页面的 Preferences 对话框列出了可用(已安装)的脚本项目。脚本项目可以安装、删除或重新排序。

对话框的 Scripting System – Global Projects 页面的 Preferences对话框
对话框的 Scripting System – Global Projects 页面的 Preferences对话框

表单设计器首选项

脚本系统 - 表单设计器页面的 Preferences 对话框提供了脚本表单文档的网格和组件代号选项。

对话框的 Scripting System – Form Designer页面的 Preferences 对话框
对话框的 Scripting System – Form Designer页面的 Preferences 对话框

AI-LocalizedAI 翻译
如您发现任何问题,请选中相关文本/图片,并按 Ctrl + Enter 键向我们提交反馈。
功能可用性

您可使用的功能取决于您所选择的 Altium 解决方案 —— Altium DevelopAltium Agile(Agile Teams 或 Agile Enterprise 版本),或仍在有效订阅期内的 Altium Designer。

如果您在软件中未找到文中提及的功能,请联系 Altium 销售团队了解更多信息。

旧版文档

Altium Designer 文档不再提供版本区分。如果您需要访问 Altium Designer 旧版本的文档,请前往其他安装程序页面的旧版文档部分。

Content