脚本

脚本对象是 Opus 提供的两个通用脚本对象之一。当调用其各种事件处理程序时,会将此对象提供给脚本加载项(但 OnInit 事件除外)。它提供与脚本自身相关的信息。

属性名称返回类型说明

config

返回表示此脚本的配置值**ScriptConfig**对象。在 OnInit 方法中,脚本可以定义构成其配置的属性 - 然后用户可以在配置中编辑这些值。config 属性返回的对象表示用户选择的那些值。

file

字符串

返回此脚本的路径和文件名。

vars

对象:Vars

返回表示属于此特定脚本作用域的变量的 Vars 对象。这允许脚本使用从脚本的一次调用持久存在到另一次调用的变量。

方法名称

参数

返回类型

说明

InitColumns

如果脚本实现了 OnAddColumns 事件,则可以随时调用 InitColumns 方法来重新初始化其列。例如,您可能希望在用户修改了脚本的配置后执行此操作。

InitCommands

如果脚本实现了 OnAddCommands 事件,则可以随时调用 InitCommands 方法来重新初始化其命令。例如,您可能希望在用户修改了脚本的配置后执行此操作。

LoadImage

<字符串:名称> [<整数:宽度>] [<整数:高度>] [<布尔值:alpha>]

对象:Image

从指定外部文件加载图像文件。如果脚本捆绑为脚本包,则可以将图像文件放置在名为 images 的包的子目录中,然后通过指定图像文件的名称从脚本加载图像文件。还可以选择指定要加载图像的所需大小以及是否加载alpha通道(如果有)。

返回的 Image 对象可以作为 脚本对话框 中静态控件的 Control.label 属性的值(当该控件处于“图像”模式时)。还可以将其分配给 Dialog 对象的 icon 属性,为脚本对话框指定自定义窗口图标。

LoadResources

<字符串:名称> 或 <字符串:XML>

加载外部脚本资源,并使它们对脚本可用。可以提供文件名或原始 XML 字符串。如果脚本作为一个脚本包进行捆绑,则资源文件必须具有 .odxml 扩展名,以便 LoadResources 能够在包中找到它。

RefreshColumn

<字符串:名称>

如果脚本实现了任何自定义列,则可以使用此方法让它们在当前显示在任何标签中时重新生成。例如,您可能希望在用户修改了脚本的配置后执行此操作。将要重新生成列的名称作为参数传递给此方法。

Update即时查找Flags

<字符串:名称> <整数:标志>

让脚本加载项更新即时查找扩展 的标记。这相当于在快速键配置页上为用户显示的即时查找模式的选项。

名称应该是即时查找扩展命令的名称; 此名称作为 Script即时查找CommandData.fayt 属性提供给命令。标志值应表示对扩展有意义的标志组合。

最后更新于