Func
The Func object is passed to a script when it is invoked via a command. In a script function, it is passed to the OnClick method as the ClickData.func property, and in a script add-in that adds an internal command, via the ScriptCommandData.func property. The Func object provides information about the default source and destination of the command, as well as details about how it was invoked.
args
object:Args
Returns an Args object that provides access to any arguments given on the command line that invoked this script. This is used when the script has added an internal command to Opus. A command line template can be provided when the command is added, and any arguments the user provides on the command line for the script command will be available via this object. For most use the argsmap property may be an easier way to access your command's arguments.
argsmap
object:Map
command
object:Command
This property returns a pre-filled Command object that can be used to run commands against the source and destination tabs. Using this object is the equivalent of calling DOpusFactory.Command and setting the source and destination tabs manually.
fromdrop
bool
Returns True if the command was invoked via a drag-and-drop operation.
fromkey
bool
Returns True if the command was invoked via the keyboard (i.e. via a hotkey rather than a button).
qualifiers
string
Returns a string indicating any qualifier keys that were held down by the user when the command was invoked.
The string can contain any or all of the following: shift, ctrl, alt, lwin, rwin.
If no qualifiers were down, the string will be: none
viewer
object:Viewer
If this button was run from the standalone image viewer, this object represents the viewer window.
最后更新于