Sally: Plugins: Automation: Reference

Salamander Object

The Salamander object is the root object of the Sally Automation object model hierarchy. It never needs to be instantiated before invoking its properties and methods, and it is always available from any script file.

Methods

Name Description
AbortScript Forces script execution to stop.
DebugBreak Breaks into the debugger.
ErrorDialog Displays a dialog box with an error message.
GetFullPath Returns an absolute canonical path for the specified path string.
GetPersistentVal Retrieves a value from persistent storage.
InputBox Allows the user to enter text.
MatchesMask Matches a file name against the specified file mask.
MsgBox Displays a message in a dialog box.
OverwriteDialog Displays a file-overwrite confirmation dialog box.
QuestionDialog Displays a dialog box with a question.
SetPersistentVal Saves a value across script invocations.
Sleep Suspends script execution for a specified length of time.
TraceE Sends an error message to the Trace Server.
TraceI Sends an informational message to the Trace Server.
ViewFile Opens a file in the associated viewer.

Properties

Name Description
AutomationVersion Gets the Automation plugin version number.
Forms Contains objects for creating a user interface.
LeftPanel Gets an instance of the Panel object representing the left panel.
ProgressDialog Gets an instance of the ProgressDialog object representing the progress dialog.
RightPanel Gets an instance of the Panel object representing the right panel.
Script Retrieves the ScriptInfo object that contains information about the currently running script.
SourcePanel Gets an instance of the Panel object representing the source panel.
TargetPanel Gets an instance of the Panel object representing the target panel.
Version Gets the Sally version number.
WaitWindow Gets an instance of the WaitWindow object representing the wait window.
WindowsVersion Gets the Windows operating system packed version number.

See Also

Panel Object

ProgressDialog Object

Salamander Forms

ScriptInfo Object

WaitWindow Object