The Script object is one of the two global script objects provided by Opus. This object is provided to script addins when their various event handlers are invoked (other than for the OnInit event). It provides information relating to the script itself.
| Property Name | Return Type | Description |
|---|---|---|
config |
object:ScriptConfig |
Returns a ScriptConfig object representing the configuration values for this script. In the OnInit method a script can define the properties that make up its configuration - the user can then edit these values in Preferences. The object returned by the config property represents the values that the user has chosen. |
file |
string |
Returns the path and filename of this script. |
vars |
object:Vars |
Returns a Vars object that represents the variables that are scoped to this particular script. This allows scripts to use variables that persist from one invocation of the script to another. |
| Method Name | Arguments | Return Type | Description |
|---|---|---|---|
InitColumns |
none |
none |
If your script implements the OnAddColumns event, you can call the InitColumns method at any time to reinitialize your columns. You may want to do this, for example, in response to the user modifying your script's configuration. |
InitCommands |
none |
none |
If your script implements the OnAddCommands event, you can call the InitCommands method at any time to reinitialize your commands. You may want to do this, for example, in response to the user modifying your script's configuration. |
LoadImage |
<string:name> |
object:Image |
Loads an image file from the specified external file. If your script is bundled as a script package you can place image files in a sub-directory of the package called images and then load them from your script by giving their name. If width and height are not provided, they default to 0, meaning the image is loaded at its native size. The width and height parameters only specify the desired size; the resultant image may be smaller or larger, and should be scaled after loading if you need it to be an exact size. The main purpose of the width and height parameters is to influence which image within an icon is loaded; most other image formats either ignore the parameters or only use them to speed things up, such as avoiding a full JPEG decode if a partial decode can satisfy the desired image size. Images are loaded transparently (with alpha) by default; set the alpha argument to False if you want to disable that. The returned Image object can be given as the value of the Control.label property for a static control in a script dialog (when that control is in "image" mode). You can also assign as to the icon property of a Dialog object to specify a custom window icon for your script dialog. |
LoadResources |
<string:name> or |
none |
Loads external script resources and makes them available to the script. You can either provide a filename or a raw XML string. If your script is bundled as a script package, the resource file must have a .odxml extension for LoadResources to be able to find it in the package. |
RefreshColumn |
<string:name> |
none |
If your script implements any custom columns, you can use this method to cause them to be regenerated if they are currently shown in any tabs. You may want to do this, for example, in response to the user modifying your script's configuration. Pass the name of the column you want to regenerate as the argument to this method. |
UpdateFAYTFlags |
<string:name> |
none |
Lets a script add-in update the flags for a FAYT extension. This equates to the options shown to the user for the FAYT mode on the Quick Keys Preferences page. The name should be the name of the FAYT extension command; this is given to your command as the ScriptFAYTCommandData.fayt property. The flags value should represent a flag combination that's meaningful to your extension. |