图形组件脚本

概览

探索 Altium Designer 中可用于脚本编写的图形组件,从基于 VCL 的控件到 Altium 专用组件。本参考文档介绍如何创建脚本窗体、查找组件的属性、方法和事件,以及使用 Tool Palette(工具选项板)和 Object Inspector(对象检查器)面板自定义窗体的外观与行为。继续阅读,让您更有信心地使用脚本窗体及其控件。

- 学习如何创建脚本窗体,并从 Tool Palette(工具选项板)面板添加控件。
- 了解如何检查属性、查找方法,以及为用户交互生成事件处理程序。
- 理解用于控制窗体外观、窗口行为、键盘输入和初始焦点的各项设置。
使用 AI 深入了解:
 

本参考文档概述了脚本支持的图形组件及其主要属性和方法。

Altium Designer 脚本中可用的可视窗体组件大多派生自 Embarcadero 的可视组件库(VCL)。该库包含一系列预定义的可视组件,用于使用 Delphi 和 C++ 语言开发 Windows 应用程序。

VCL 是一个可视类库,其类在线性的对象层次结构中派生自 TComponent 对象(该对象本身又派生自 TObject 根对象)。因此,常见的脚本组件(例如 TButton 对象)会继承其上级对象的属性、方法和事件。在此示例中,类层次结构为:TObject → TPersistent → TComponent → TControl → TWinControl → TButtonControl → TButton。

请注意,派生自 TControl 对象的组件通常是可视组件(控件),而派生自 TWinControl 的常见组件大多是对 Windows API 的封装。

► 请参阅 Embarcadero RAD Studio VCL,了解 VCL 架构和组件的概况。

在 Altium Designer 脚本编辑器中创建窗体时,可从 Tool Palette 面板访问这些组件。脚本窗体具有关联的 *.DFM 文件,其中包含窗体配置、组件位置及其他属性的详细信息,该文件位于脚本项目所在的文件夹中。在设计脚本窗体时,Altium Designer 允许通过 DelphiScript 或 VBScript 使用这些组件。

VBScript 语言被视为旧版语言,默认不可用,但可通过高级首选项中的 Legacy.Scripts.SupportOldLanguages 设置启用。

Tool Palette 面板包含按类别组织的可视控件,可将这些控件拖放到脚本窗体上。
Tool Palette 面板包含按类别组织的可视控件,可将这些控件拖放到脚本窗体上。

工具选项板面板包含按类别组织的组件,可将其放置在脚本窗体上。可用组件在 Tool Palette 面板中以可展开的分区呈现,分为标准、附加、Win32、系统、对话框、Altium 标准和仪器控件等类别。

可通过面板的右键快捷菜单更改其外观和行为。

选项板中可用的组件(或“控件”)在脚本窗体上使用时属于可视组件,这意味着用户可以在运行时看到控件,并可能与之交互。所有控件都具有属性、方法和事件,用于描述其外观等方面的特征,例如控件的位置属性、用于绘制或移动控件的方法,以及响应用户操作的事件。

当前选中的窗体组件(包括窗体本身)的属性和事件可在对象检查器面板中查看。方法则是该组件支持的过程和函数。

脚本窗体概述

脚本窗体

脚本窗体是脚本中的主要用户界面,不过也存在其他形式的界面,例如对话框、辅助窗口等。要创建新的脚本窗体,请在 Altium Designer 中打开项目后,选择 File » New » Script » Script Form,或右键单击脚本项目名称并选择 Add New to Project » Script Form。如果已启用 VBScript 语言,则 VB Script 和 Delphi Script 均可使用此命令。

新建脚本窗体的默认名称为 Form1,可通过 Object Inspector 面板中的 Name 属性(位于 Misc 下)进行更改。同一项目中的脚本窗体名称应唯一。

设计脚本窗体时,可通过底部状态栏中的 Script 按钮打开 Object Inspector 面板。设计脚本窗体时,可通过底部状态栏中的 Script 按钮打开 Object Inspector 面板。

空白窗体本质上是一个可添加控件的可视窗口。对话框和面板是不同类型的窗体。默认情况下,窗体包含以下标准窗口功能:

  • 控件
  • 最小化和最大化按钮
  • 标题栏
  • 通过拖动边框调整大小

这些功能以及其他所有可用的窗体属性,都可以在设计时使用 Object Inspector 面板进行更改。由于脚本窗体是一个 VCL 组件,因此它具有以下三项要素:

  • Properties – 对象的特征,会影响其可见行为或操作。例如,Visible 属性决定对象在脚本窗体上是否可见。
  • Events – 脚本检测到的操作或事件。脚本必须为每个事件处理程序提供代码,以捕获特定事件,例如鼠标单击。
  • Methods – 与对象(此处为组件对象)关联并定义其行为的脚本过程。

► 请参阅编写脚本,了解开发基于窗体的脚本的基本指南。

窗体属性、方法和事件

Tool Palette 面板中的控件基于 Embarcadero 可视组件库(VCL)。有关窗体组件(TForm)的方法、属性和事件的完整详细信息,请参阅 Embarcadero VCL 文档。

► 请参阅 Embarcadero TForm 参考文档

请注意,上述链接指向 VCL 库的 Embarcadero RAD Studio XE6 参考文档。还可查阅早期版本(最早可追溯到 2010 版)的文档。

TForm 属性

可通过以下方式查看 TForm 组件对象(基础脚本窗体)的可用属性:

  • 通过 Object Inspector 面板 – 在编辑器的窗体视图中(选中 Form 选项卡),单击窗体本体,然后选择 Object Inspector's Properties 选项卡。

请注意,面板中只会显示可视组件对象。作为后台控件的非可视对象不会显示在窗体上。

  • 使用代码补全功能 – 在编辑器的代码视图中(选中 Code 选项卡),上下文相关的代码补全窗口会显示某个对象名称对应的所有代码选项。

对于窗体对象,输入 TForm.(注意句点)以激活该窗口。输入所需属性的前几个字母可缩小搜索范围,请注意,其中会同时显示属性和方法。

TForm 方法

可通过以下方式查看 TForm 组件对象的可用方法:

  • 使用代码补全功能 – 在编辑器的代码视图中,输入组件名称,后跟一个句点。代码补全窗口随即打开,显示该对象名称对应的代码方法(及属性)。请注意,也可使用 Crtl+Space 快捷键手动激活代码补全窗口。

  • 查阅 Embarcadero 参考文档中的 TForm 方法参考页面。请注意,该页面会显示所有继承的方法,但可以取消选择此选项。

TForm 事件

可通过以下方式查看 TForm 组件对象的可用事件:

  • 对象检查器面板 – 在编辑器的窗体视图中,单击窗体本体,然后选择对象检查器的 Events 选项卡。

组件属性、事件和方法

Tool Palette 面板中的控件基于 Embarcadero 可视组件库 (VCL)。有关大多数组件的方法、属性和事件的完整详细信息,请参阅 Embarcadero VCL 文档中的组件类别。Tool Palette 中的某些组件类型,尤其是 Altium 仪表控件,是 Altium Designer 专有的组件,未包含在 Embarcadero 参考文档中。

► 请参阅 Embarcadero VCL 组件类别索引

请注意,上述链接指向 Embarcadero RAD Studio XE6 的 VCL 库参考文档。此外,也可查阅早期版本(最早至 2010 版)的文档。

组件属性

要查看组件的属性列表:

  • 在窗体上选择一个组件,然后激活 Object Inspector 面板中的 Properties 选项卡,如上方的 TForm 组件对象所示。
  • 在 Embarcadero 参考文档中相应的组件参考页面上,选择顶部的“属性”链接。例如,对于 TButton 控件,请选择 标准组件类别、TButton 页面,然后选择属性视图。

组件事件

要查看组件可响应的事件列表:

  • 在窗体上选择一个组件,然后激活 Object Inspector 面板中的 Events 选项卡,如上方的 TForm 组件对象所示。
  • 在 Embarcadero 参考文档中选择相应的组件参考页面,然后选择其“事件”链接。请注意,这可用作了解组件可用事件的指南,但可能与 Altium Designer 脚本组件的可用事件不完全一致。

要创建事件处理过程,请在 Object Inspector Events 选项卡中选择组件应响应的事件,然后双击该事件的输入字段。随后,脚本中将自动生成以组件和事件操作命名的事件处理过程。如果在 Object Inspector 面板中重命名该事件,相应的代码过程也会随之重命名。

组件方法

有关 Tool Palette 组件可用方法的信息,请参阅组件类别文档。

其中包含以下控件对象类别的参考资料。

  • 标准
  • 附加
  • Win32
  • 系统
  • 对话框
  • Altium 标准
  • 仪表控件

这些类别大多汇集了基于标准 Delphi 类型 VCL 组件的各类可视化窗体控件。“Altium 标准”和“仪表控件”类别则是例外,因为它们提供的是 Altium Designer 脚本系统专有的组件。

► 请参阅Tool Palette 组件类别。

使用窗体和组件

自定义脚本窗体

  • 例如,要使窗体始终显示在其他已打开的面板之上,请将 FormStyle 属性设置为 fsStayOnTop。
  • 要定义窗体的默认行为,请将 FormKind 设置为以下值之一:fkNone, fkNormal, fkServerPanel 或 fkModal。
    • 如果选择 fkModal,窗体将成为模态窗体。也就是说,窗体会等待用户输入,然后再继续执行关闭窗体等操作。
    • 如果选择 fkServerPanel,窗体将显示为服务器面板。
    • 如果选择 fkNormal,窗体将作为普通的非模态窗体运行。
  • 要添加或移除窗体的滚动条,请更改 HorzScrollBar 和 VertScrollBar 属性的值。
  • 要使窗体成为 MDI(多文档界面)框架或子窗体,请使用 FormStyle 属性。
  • 要更改窗体的边框样式,请使用 BorderIcons 和 BorderStyle 属性。(效果在运行时可见。)
  • 要更改窗体最小化时的图标,请使用 Icon 属性。
  • 要指定窗体在应用程序窗口中的初始位置,请使用 Position 属性。
  • 要指定窗体的初始状态(例如最小化、最大化或正常),请使用 WindowState 属性。
  • 要定义窗体在运行时的工作区域,请使用 ClientHeight 和 ClientWidth 属性。请注意,ClientHeight 和 ClientWidth 表示窗体边框内的区域,而 Height 和 Width 表示窗体的整个区域。
  • 要指定运行时窗体中初始获得焦点的控件,请使用 ActiveControl 属性从可用组件中进行选择。
  • 要将所有键盘事件传递给窗体,而不受所选控件的影响,请使用 KeyPreview 属性。
  • 如果窗体包含多个菜单,要指定某个特定菜单,请使用 Menu 属性。

刷新窗体和组件

在某些情况下,脚本窗体的显示内容可能未能及时更新。例如,脚本执行密集的后台处理,导致控件未能更新或重绘,看起来像是卡住或显示异常。

脚本窗体的 Update 方法提供了一种以编程方式刷新窗体或特定控件图形内容的途径。在下面的代码示例中,Update 方法的代码行以灰色突出显示。

Using the Update method to refresh the Status Bar:

Procedure TConverterForm.loadbuttonClick(Sender: TObject);
Var
   I, J : Integer;
Begin
    If OpenPictureDialog1.Execute then
    Begin
        XPProgressBar1.Position := 0;
        XStatusBar1.SimpleText  := '  Loading...';
        XStatusBar1.Update;

        // loading a monochrome bitmap only
        Image1.Picture.LoadFromFile(OpenPictureDialog1.FileName);

        // Check if image is monochrome, otherwise prompt a warning
        If Image1.Picture.Bitmap.PixelFormat <> pf1bit Then
        Begin
            For J := 0 to Image1.Picture.Height – 1 Do
                For I := 0 to Image1.Picture.Height – 1 Do
            Begin
                If Image1.Canvas.Pixels[I,J] <> clWhite Then
                    Image1.Canvas.Pixels[I,J] := clBlack;
            End;
        End;

        ScalingFactorChange(Nil);

        convertbutton.Enabled  := True;
        LoadButton.Enabled     := False;
        XStatusBar1.SimpleText := '  Ready...';
        XStatusBar1.Update;
    End;
End;

请参阅可下载的 脚本集合中 Scripts\Delphiscript Scripts\PCB\PCB Logo Creator 文件夹下的 PCB Logo Creator 脚本项目。

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

您可使用的功能取决于您所采用的 Altium 解决方案——Altium Develop、Altium Agile Teams、Altium Agile Enterprise,或 Altium Designer(在有效订阅期内)。

如果您在实际软件中未看到文档中介绍的某项功能, 请联系 Altium Sales 了解更多信息。

旧版文档

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

Contents