Scriptable object, inherited from IApplication

Script Application Object

Property Description
ActiveDocument Active document object
ActiveView Active view object
Commands Command list. SAFEARRAY of BSTR
Documents Open documents collection
FileSystemManager File System Manager object
FolderFavorites Favorite Folders management object
Interactive Identifies the script mode
MainWindow Main window handle
Panes Pane list
Path Full path and name of the executable
Project Project object
Repository Repository object
Script Return active script object
ScriptArguments Script arguments
ScriptName Script name
Settings Global settings object
Shell Shell Object
Version Application version
WScript Returns WScript emulation object
Event Handler Description
onApplicationClose Handler for IFrameEvents::onApplicationClose
onBundleInstalled Handler for IFrameEvents::onBundleInstalled
onBundleUninstalled Handler for IFrameEvents::onBundleUninstalled
onCanCloseApplication Handler for IFrameEvents::CanCloseApplication
onCanCloseWorkspace Handler for IFrameEvents::CanCloseWorkspace
onCompletion Handler for IFrameEvents::onCompletion
onCursorPosChange Handler for IFrameEvents::onCursorPosChange
onDocumentClose Handler for IFrameEvents::onDocumentClose
onDocumentDeleted Handler for IFrameEvents::onDocumentDeleted
onDocumentListUpdate Handler for IFrameEvents::onDocumentListUpdate
onDocumentLoaded Handler for IFrameEvents::onDocumentLoaded
onDocumentNameChange Handler for IFrameEvents::onDocumentNameChange
onDocumentOpen Handler for IFrameEvents::onDocumentOpen
onDocumentSave Handler for IFrameEvents::onDocumentSave
onDocumentStateUpdate Handler for IFrameEvents::onDocumentStateUpdate
onDocumentSwitch Handler for IFrameEvents::onDocumentSwitch
onEditOperation Handler for IFrameEvents::onEditOperation
onFileDrop Handler for IFrameEvents::onFileDrop
onFocusLost Handler for IFrameEvents::onFocusLost
onFocusSet Handler for IFrameEvents::onFocusSet
onHotSpotNavigate Handler for IFrameEvents::onHotSpotNavigate
onIdle Handler for IFrameEvents::onIdle
onInitContextMenu Handler for IContextMenuHandler::Init
onInitMainMenu Handler for IMainMenuHandler::Init
onInitStatusBar Handler for IStatusBarHandler::Init
onInitToolbars Handler for IToolBarHandler::Init
onJobFinished Handler for IFrameEvents::onJobFinished
onListCheck Handler for IListPaneEvents::onCheck
onListDoubleClick Handler for IListPaneEvents::onDoubleClick
onListInitContextMenu Handler for IListPaneEvents::onInitContextMenu
onMainSubmenuUpdate Handler for IMainMenuHandler::OnSubMenuUpdate
onMenuCreate Handler for IUIEvents::onMenuCreate
onModifiedChange Handler for IFrameEvents::onModifiedChange
onNewDocument Handler for IFrameEvents::onNewDocument
onOutputCommand Handler for IOutputPaneEvents::onCommand
onOutputInitContextMenu Handler for IOutputPaneEvents::onInitContextMenu
onOutputNavigate Handler for IOutputPaneEvents::onNavigate
onOutputToolStateChange Handler for IOutputPaneEvents::onToolStateChange
onPopupCreate Handler for IUIEvents::onPopupCreate
onProjectChanged Handler for IProjectEvents::onProjectChanged
onProjectLoad Handler for IProjectEvents::onProjectLoad
onProjectSave Handler for IProjectEvents::onProjectSave
onQuickInfo Handler for IFrameEvents::onQuickInfo
onScroll Handler for IFrameEvents::onScroll
onSelectionChange Handler for IFrameEvents::onSelectionChange
onSettingsChange Handler for IFrameEvents::onSettingsChange
onSyntaxChange Handler for IFrameEvents::onSyntaxChange
onTextDrop Handler for IFrameEvents::onTextDrop
onTextFormat Handler for IFrameEvents::onTextFormat
onTextInsert Handler for IFrameEvents::onTextInsert
onUICreate Handler for IUIEvents::onUICreate
onWorkspaceClose Handler for IFrameEvents::onWorkspaceClose
onWorkspaceOpen Handler for IFrameEvents::onWorkspaceOpen
Method Description
__import Dynamically import file into global scope
__include Dynamically include file into global scope
__require Access external module (include) without exposing it to global scope
AddAutoCorrection Add auto correction item
AddPane Add new tool pane
AddScriptInfo Places version and copyright information about the script to engine
AddUndoActionType Registers new Undo type
alert Displays a message in a simple dialog box with the OK button
atob Decodes a string of data which has been encoded using base-64 encoding into string or binary data array
attachEvent Helper to attach more than one handler to event plug
btoa Creates a base-64 encoded ASCII string from a string of binary data
cancel_call Cancels previously registered callback using ID received from delay_call
CaptureOutput Captures tool output
Clipboard Return clipboard by name
ClosePane Close open tool pane
CodeTemplate CodeTemplate constructor
Command Command object constructor
CommandListener Command listener constructor
CompletionItem CompletionItem object constructor
CompletionProvider CompletionProvider object constructor
CompletionSet CompletionSet object constructor
confirm Displays a message in a simple dialog box with the OK button and the Cancel button
CreateRange Creates Range Object from Position objects
CreateRange2 Creates Range Object from lines + positions
delay_call Calls the given callback after the given delay (in milliseconds)
detachEvent Helper to detach handler from event plug
dialog Displays free style dialog box, based on XML layout description
ExecuteCommand Execute existing command nCount times, with “enabled” check
ExpandTemplate Expand template code
file_operation File operation helpers
FindCodeTemplate Search for existing Code Template handler
FindCommand Search for existing command by name
FindEx Find text in a way similar to interactive search
FindInFiles Finds text in specific file or directory files
FindInFilesAll Finds all matches text in the document
FindPane Find existing tool pane
FindShortKey Search for existing ShortKey handler
GetDocument Returns opened document, if one exist
GetFileNameColor Returns color associated with provided file name
GetIconDefaultSize Returns default image size (width is equal to height)
GetStorage Returns storage object
GetUndoActionDescription Returns description, associated with Undo Action type, if provided type registered
GetUserConfigurations User configurations. SAFEARRAY of BSTR
GetUserVariable Read user variable value by name
GetUserVariables User variables (global, workspace, project). SAFEARRAY of BSTR
List Return list pane by name
md5 Creates a MD5 hash from string
Navigate Navigates to position in document, opening it if necessary
NewFile Creates a new file and returns reference to it
NewFileEx Creates a new file of specific type and returns reference to it
OpenFile Opens an existing file with or w/o file dialog and returns reference to it
OpenFileEx Opens an existing file with or w/o file dialog, using specific viewer (selected by document type) and returns reference to it
OpenHelp Opens Help for provided word (URL, chm) in internal/external browser
OpenURL Opens URL in the internal browser
Output Return output pane by name
PathFromRelative Convert path from relative to full form
PathToRelative Convert path to relative form
Point Creates Point Object
Position Creates Position Object
progress Sets progress state
Prompt Displays a dialog box to enter a string with possible default value
Quit Forces script execution to stop at any time
Range Range object constructor with support of variable arguments
read_file Reads file data as string or binary
RegisterCodeTemplate Register Code Template handler
RegisterCommand Register new command
RegisterCommandListener Register listener for existing command by name
RegisterCompletionProvider Register code completion provider for syntax
RegisterIcon Register Icon by Window Handle HANDLE_PTR
RegisterImageBitmap Register Icon from Bitmap
RegisterImagePath Register Icon by path
RegisterImageResource Register Icon from Application binary resource (can be bitmap, PNG or Icon of any size)
RegisterImageString Register inline Icon base64 encoded binary data
RegisterMacroTranslator Register macro translator
RegisterOptionsPage Registers Options page
RegisterShortKey Register ShortKey handler
RegisterTool Register a tool
RegisterVariable Register external variable (vValue can be explicit BSTR value or IVariableHandler* callback)
RemoveAutoCorrection Remove auto correction item
ReplaceEx Replace text in a way similar to interactive search
ResolveFileName Resolves incomplete file name
save_file Save file data
SelectFiles Displays Application File Save/Open dialog. SAFEARRAY of BSTR
ShortKey ShortKey constructor
ShowOptions Show options dialog
ShowSearchDlg Show search dialog
sleep Pauses execution for the specified time in milliseconds
status Sets status message
Storage Creates initial storage object
Style Creates Style Object
UnRegisterCodeTemplate UnRegister Code Template handler
UnRegisterCommand UnRegister a command
UnRegisterCommandListener UnRegister listener for existing command by instance
UnRegisterCompletionProvider UnRegister code completion provider for syntax by instance
UnRegisterMacroTranslator UnRegister macro translator
UnRegisterOptionsPage UnRegisters Options page
UnRegisterShortKey UnRegister ShortKey handler
UnRegisterTool UnRegister a tool
UnRegisterVariable UnRegister external variable
UpdateAll Update all open documents
uuid_generate Generates new UUID
Variable Built-in variable constructor
wtoa Converts Unicode text to ASCII