ScriptInitData

ScriptInitData 对象传递给脚本插件中的 OnInit 事件(/Manual/scripting/script_add-ins/README.zh.md)。脚本应该初始化各种属性以标识自身,并且可以选择使用 AddCommand 方法 添加内部命令,并在返回之前使用 AddColumn 方法 自定义列

属性名称返回类型描述

config

返回 ScriptConfig 对象,该对象可用于初始化脚本的默认配置。在此方法中添加到对象的属性将以配置显示给用户,允许他们更改其值,从而配置脚本的行为。

config_desc

object:Map

这允许你为脚本配置选项指定描述信息,这些描述信息以编辑程序对话框中显示给用户。为此,将此属性设置为通过 DOpusFactory.Map 方法创建的 Map,并填充名称/描述字符串对。

config_groups

object:Map

这允许你将脚本配置选项组织到组中,当在编辑程序对话框中显示给用户时。组名称是任意的 - 具有相同组名称的配置选项将显示为一组。将此属性设置为通过 DOpusFactory.Map 方法创建的 Map,并填充名称/组字符串对。

copyright

string

允许脚本指定在配置中显示给用户的版权消息。

default_enable

bool

如果脚本应默认启用,则将其设置为 True;如果脚本应默认禁用,则将其设置为 False。用户可以使用配置启用或禁用脚本 - 这仅控制默认状态。

desc

string

允许脚本指定在配置中显示给用户的描述消息。

early_dblclk

bool

如果你希望脚本实现 OnDoubleClick 事件,并且(出于性能原因)你只希望被调用时提供双击的项目路径,而不是完整的 Item 对象,则将其设置为 True。有关更多详细信息,请参阅 OnDoubleClick 事件文档。

file

string

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

group

string

允许你为该脚本指定任意组。如果脚本指定了一个组,它们将显示在配置列表中的该组中。

log_prefix

string

允许脚本指定一个字符串,该字符串将作为前缀,附加到它执行的任何日志输出中。如果没有设置,则默认使用脚本名称。

min_version

string

指定需要的 Opus 最低版本。如果当前版本低于指定版本,则脚本将被禁用。你只能指定主版本(例如,“11”),主版本和次要版本(例如,“11.3”)或特定 beta 版本(例如,“11.3.1”,表示 11.3 Beta 1)。

name

string

允许脚本指定在配置中显示的脚本的显示名称。

startup

bool

OnInit 方法在两种不同的情况下被调用 - 一次是在 Opus 启动期间,当 Opus 已在运行时再次在安装或编辑脚本时。如果在 Opus 启动期间调用 OnInit 方法,则此属性将返回 True;否则,将返回 False

url

string

允许你提供一个 URL,用户可以访问该 URL 查找有关脚本的更多信息(它以配置显示给用户)。

vars

object:Vars

返回 Vars 收集用户和脚本定义的变量,这些变量是此脚本的局部变量。这些变量可通过 Script.vars 属性在脚本中的其它方法中使用。

version

string

允许脚本指定在配置中显示给用户的版本号字符串。

方法名称

参数

返回类型

描述

AddColumn

none

向 Opus 添加新的信息列。返回的 ScriptColumn 对象必须已正确初始化。脚本插件可以根据需要添加任意多的列,并且这些列将可在文件列表、信息提示和 高级查找 功能中使用。

你的脚本可以在 OnInit 中添加列,也可以实现 OnAddColumns 方法。这么做更灵活,因为它允许你在添加列时访问脚本的配置,并且可以在 Opus 运行时动态添加和删除列。如果实现了 OnAddColumns,则此方法在 OnInit 中不可用。

AddCommand

none

向 Opus 添加新的内部命令。返回的 ScriptCommand 对象必须已正确初始化。脚本插件可以根据需要向 Opus 内部命令集添加任意多的内部命令。

你的脚本可以在 OnInit 中添加命令,也可以实现 OnAddCommands 方法。这么做更灵活,因为它允许你在添加命令时访问脚本的配置,并且可以在 Opus 运行时动态添加和删除命令。如果实现了 OnAddCommands,则此方法在 OnInit 中不可用。

最后更新于