Show pageOld revisionsBacklinksAdd to bookBack to top This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong. ====== IScriptApplication ====== Scriptable object, inherited from [[:scripting:api:application:start|IApplication]] ===== Description ===== Script Application Object ===== Properties ===== ^Property^ Description^ |[[scripting:api:application:active-document|ActiveDocument]]| Active document object| |[[scripting:api:application:active-view|ActiveView]]| Active view object| |[[scripting:api:application:commands|Commands]]| Command list. SAFEARRAY of BSTR| |[[scripting:api:application:documents|Documents]]| Open documents collection| |[[scripting:api:application:file-system-manager|FileSystemManager]]| File System Manager object| |[[scripting:api:application:folder-favorites|FolderFavorites]]| Favorite Folders management object| |[[scripting:api:script-application:interactive|Interactive]]| Identifies the script mode| |[[scripting:api:application:main-window|MainWindow]]| Main window handle| |[[scripting:api:application:panes|Panes]]| Pane list| |[[scripting:api:application:path|Path]]| Full path and name of the executable| |[[scripting:api:application:project|Project]]| Project object| |[[scripting:api:application:repository|Repository]]| Repository object| |[[scripting:api:script-application:script|Script]]| Return active script object| |[[scripting:api:script-application:script-arguments|ScriptArguments]]| Script arguments| |[[scripting:api:script-application:script-name|ScriptName]]| Script name| |[[scripting:api:application:settings|Settings]]| Global settings object| |[[scripting:api:application:shell|Shell]]| Shell Object| |[[scripting:api:application:version|Version]]| Application version| |[[scripting:api:script-application:wscript|WScript]]| Returns WScript emulation object| ===== Event Handlers ===== ^Event Handler^ Description^ |[[scripting:api:script-application:on-application-close|onApplicationClose]]| Handler for [[:scripting:api:frame-events:on-application-close|IFrameEvents::onApplicationClose]]| |[[scripting:api:script-application:on-bundle-installed|onBundleInstalled]]| Handler for [[:scripting:api:frame-events:on-bundle-installed|IFrameEvents::onBundleInstalled]]| |[[scripting:api:script-application:on-bundle-uninstalled|onBundleUninstalled]]| Handler for [[:scripting:api:frame-events:on-bundle-uninstalled|IFrameEvents::onBundleUninstalled]]| |[[scripting:api:script-application:on-can-close-application|onCanCloseApplication]]| Handler for [[:scripting:api:frame-events:can-close-application|IFrameEvents::CanCloseApplication]]| |[[scripting:api:script-application:on-can-close-workspace|onCanCloseWorkspace]]| Handler for [[:scripting:api:frame-events:can-close-workspace|IFrameEvents::CanCloseWorkspace]]| |[[scripting:api:script-application:on-completion|onCompletion]]| Handler for [[:scripting:api:frame-events:on-completion|IFrameEvents::onCompletion]]| |[[scripting:api:script-application:on-cursor-pos-change|onCursorPosChange]]| Handler for [[:scripting:api:frame-events:on-cursor-pos-change|IFrameEvents::onCursorPosChange]]| |[[scripting:api:script-application:on-document-close|onDocumentClose]]| Handler for [[:scripting:api:frame-events:on-document-close|IFrameEvents::onDocumentClose]]| |[[scripting:api:script-application:on-document-deleted|onDocumentDeleted]]| Handler for [[:scripting:api:frame-events:on-document-deleted|IFrameEvents::onDocumentDeleted]]| |[[scripting:api:script-application:on-document-list-update|onDocumentListUpdate]]| Handler for [[:scripting:api:frame-events:on-document-list-update|IFrameEvents::onDocumentListUpdate]]| |[[scripting:api:script-application:on-document-loaded|onDocumentLoaded]]| Handler for IFrameEvents::onDocumentLoaded| |[[scripting:api:script-application:on-document-name-change|onDocumentNameChange]]| Handler for [[:scripting:api:frame-events:on-document-name-change|IFrameEvents::onDocumentNameChange]]| |[[scripting:api:script-application:on-document-open|onDocumentOpen]]| Handler for IFrameEvents::onDocumentOpen| |[[scripting:api:script-application:on-document-save|onDocumentSave]]| Handler for [[:scripting:api:frame-events:on-document-save|IFrameEvents::onDocumentSave]]| |[[scripting:api:script-application:on-document-state-update|onDocumentStateUpdate]]| Handler for IFrameEvents::onDocumentStateUpdate| |[[scripting:api:script-application:on-document-switch|onDocumentSwitch]]| Handler for [[:scripting:api:frame-events:on-document-switch|IFrameEvents::onDocumentSwitch]]| |[[scripting:api:script-application:on-edit-operation|onEditOperation]]| Handler for IFrameEvents::onEditOperation| |[[scripting:api:script-application:on-file-drop|onFileDrop]]| Handler for [[:scripting:api:frame-events:on-file-drop|IFrameEvents::onFileDrop]]| |[[scripting:api:script-application:on-focus-lost|onFocusLost]]| Handler for [[:scripting:api:frame-events:on-focus-lost|IFrameEvents::onFocusLost]]| |[[scripting:api:script-application:on-focus-set|onFocusSet]]| Handler for [[:scripting:api:frame-events:on-focus-set|IFrameEvents::onFocusSet]]| |[[scripting:api:script-application:on-hot-spot-navigate|onHotSpotNavigate]]| Handler for [[:scripting:api:frame-events:on-hot-spot-navigate|IFrameEvents::onHotSpotNavigate]]| |[[scripting:api:script-application:on-idle|onIdle]]| Handler for [[:scripting:api:frame-events:on-idle|IFrameEvents::onIdle]]| |[[scripting:api:script-application:on-init-context-menu|onInitContextMenu]]| Handler for [[:scripting:api:context-menu-handler:init|IContextMenuHandler::Init]]| |[[scripting:api:script-application:on-init-main-menu|onInitMainMenu]]| Handler for [[:scripting:api:main-menu-handler:init|IMainMenuHandler::Init]]| |[[scripting:api:script-application:on-init-status-bar|onInitStatusBar]]| Handler for [[:scripting:api:status-bar-handler:init|IStatusBarHandler::Init]]| |[[scripting:api:script-application:on-init-toolbars|onInitToolbars]]| Handler for [[:scripting:api:tool-bar-handler:init|IToolBarHandler::Init]]| |[[scripting:api:script-application:on-job-finished|onJobFinished]]| Handler for [[:scripting:api:frame-events:on-job-finished|IFrameEvents::onJobFinished]]| |[[scripting:api:script-application:on-list-check|onListCheck]]| Handler for [[:scripting:api:list-pane-events:on-check|IListPaneEvents::onCheck]]| |[[scripting:api:script-application:on-list-double-click|onListDoubleClick]]| Handler for [[:scripting:api:list-pane-events:on-double-click|IListPaneEvents::onDoubleClick]]| |[[scripting:api:script-application:on-list-init-context-menu|onListInitContextMenu]]| Handler for [[:scripting:api:list-pane-events:on-init-context-menu|IListPaneEvents::onInitContextMenu]]| |[[scripting:api:script-application:on-main-submenu-update|onMainSubmenuUpdate]]| Handler for [[:scripting:api:main-menu-handler:on-sub-menu-update|IMainMenuHandler::OnSubMenuUpdate]]| |[[scripting:api:script-application:on-menu-create|onMenuCreate]]| Handler for [[:scripting:api:uievents:on-menu-create|IUIEvents::onMenuCreate]]| |[[scripting:api:script-application:on-modified-change|onModifiedChange]]| Handler for IFrameEvents::onModifiedChange| |[[scripting:api:script-application:on-new-document|onNewDocument]]| Handler for [[:scripting:api:frame-events:on-new-document|IFrameEvents::onNewDocument]]| |[[scripting:api:script-application:on-output-command|onOutputCommand]]| Handler for [[:scripting:api:output-pane-events:on-command|IOutputPaneEvents::onCommand]]| |[[scripting:api:script-application:on-output-init-context-menu|onOutputInitContextMenu]]| Handler for [[:scripting:api:output-pane-events:on-init-context-menu|IOutputPaneEvents::onInitContextMenu]]| |[[scripting:api:script-application:on-output-navigate|onOutputNavigate]]| Handler for [[:scripting:api:output-pane-events:on-navigate|IOutputPaneEvents::onNavigate]]| |[[scripting:api:script-application:on-output-tool-state-change|onOutputToolStateChange]]| Handler for [[:scripting:api:output-pane-events:on-tool-state-change|IOutputPaneEvents::onToolStateChange]]| |[[scripting:api:script-application:on-popup-create|onPopupCreate]]| Handler for [[:scripting:api:uievents:on-popup-create|IUIEvents::onPopupCreate]]| |[[scripting:api:script-application:on-project-changed|onProjectChanged]]| Handler for [[:scripting:api:project-events:on-project-changed|IProjectEvents::onProjectChanged]]| |[[scripting:api:script-application:on-project-load|onProjectLoad]]| Handler for [[:scripting:api:project-events:on-project-load|IProjectEvents::onProjectLoad]]| |[[scripting:api:script-application:on-project-save|onProjectSave]]| Handler for [[:scripting:api:project-events:on-project-save|IProjectEvents::onProjectSave]]| |[[scripting:api:script-application:on-quick-info|onQuickInfo]]| Handler for [[:scripting:api:frame-events:on-quick-info|IFrameEvents::onQuickInfo]]| |[[scripting:api:script-application:on-scroll|onScroll]]| Handler for [[:scripting:api:frame-events:on-scroll|IFrameEvents::onScroll]]| |[[scripting:api:script-application:on-selection-change|onSelectionChange]]| Handler for [[:scripting:api:frame-events:on-selection-change|IFrameEvents::onSelectionChange]]| |[[scripting:api:script-application:on-settings-change|onSettingsChange]]| Handler for [[:scripting:api:frame-events:on-settings-change|IFrameEvents::onSettingsChange]]| |[[scripting:api:script-application:on-syntax-change|onSyntaxChange]]| Handler for [[:scripting:api:frame-events:on-syntax-change|IFrameEvents::onSyntaxChange]]| |[[scripting:api:script-application:on-text-drop|onTextDrop]]| Handler for [[:scripting:api:frame-events:on-text-drop|IFrameEvents::onTextDrop]]| |[[scripting:api:script-application:on-text-format|onTextFormat]]| Handler for [[:scripting:api:frame-events:on-text-format|IFrameEvents::onTextFormat]]| |[[scripting:api:script-application:on-text-insert|onTextInsert]]| Handler for [[:scripting:api:frame-events:on-text-insert|IFrameEvents::onTextInsert]]| |[[scripting:api:script-application:on-uicreate|onUICreate]]| Handler for [[:scripting:api:uievents:on-uicreate|IUIEvents::onUICreate]]| |[[scripting:api:script-application:on-workspace-close|onWorkspaceClose]]| Handler for [[:scripting:api:frame-events:on-workspace-close|IFrameEvents::onWorkspaceClose]]| |[[scripting:api:script-application:on-workspace-open|onWorkspaceOpen]]| Handler for [[:scripting:api:frame-events:on-workspace-open|IFrameEvents::onWorkspaceOpen]]| ===== Methods ===== ^Method^ Description^ |[[scripting:api:script-application:import|__import]]| Dynamically import file into global scope| |[[scripting:api:script-application:include|__include]]| Dynamically include file into global scope| |[[scripting:api:script-application:require|__require]]| Access external module (include) without exposing it to global scope| |[[scripting:api:application:add-auto-correction|AddAutoCorrection]]| Add auto correction item| |[[scripting:api:application:add-pane|AddPane]]| Add new tool pane| |[[scripting:api:script-application:add-script-info|AddScriptInfo]]| Places version and copyright information about the script to engine| |[[scripting:api:application:add-undo-action-type|AddUndoActionType]]| Registers new Undo type| |[[scripting:api:application:alert|alert]]| Displays a message in a simple dialog box with the OK button| |[[scripting:api:application:atob|atob]]| Decodes a string of data which has been encoded using base-64 encoding into string or binary data array| |[[scripting:api:script-application:attach-event|attachEvent]]| Helper to attach more than one handler to event plug| |[[scripting:api:application:btoa|btoa]]| Creates a base-64 encoded ASCII string from a string of binary data| |[[scripting:api:script-application:cancel_call|cancel_call]]| Cancels previously registered callback using ID received from delay_call| |[[scripting:api:application:capture-output|CaptureOutput]]| Captures tool output| |[[scripting:api:application:clipboard|Clipboard]]| Return clipboard by name| |[[scripting:api:application:close-pane|ClosePane]]| Close open tool pane| |[[scripting:api:script-application:code-template|CodeTemplate]]| CodeTemplate constructor| |[[scripting:api:script-application:command|Command]]| Command object constructor| |[[scripting:api:script-application:command-listener|CommandListener]]| Command listener constructor| |[[scripting:api:script-application:completion-item|CompletionItem]]| CompletionItem object constructor| |[[scripting:api:script-application:completion-provider|CompletionProvider]]| CompletionProvider object constructor| |[[scripting:api:script-application:completion-set|CompletionSet]]| CompletionSet object constructor| |[[scripting:api:application:confirm|confirm]]| Displays a message in a simple dialog box with the OK button and the Cancel button| |[[scripting:api:application:create-range|CreateRange]]| Creates Range Object from Position objects| |[[scripting:api:application:create-range2|CreateRange2]]| Creates Range Object from lines + positions| |[[scripting:api:script-application:delay_call|delay_call]]| Calls the given callback after the given delay (in milliseconds)| |[[scripting:api:script-application:detach-event|detachEvent]]| Helper to detach handler from event plug| |[[scripting:api:application:dialog|dialog]]| Displays free style dialog box, based on XML layout description| |[[scripting:api:application:execute-command|ExecuteCommand]]| Execute existing command nCount times, with "enabled" check| |[[scripting:api:application:expand-template|ExpandTemplate]]| Expand template code| |[[scripting:api:application:file_operation|file_operation]]| File operation helpers| |[[scripting:api:application:find-code-template|FindCodeTemplate]]| Search for existing Code Template handler| |[[scripting:api:application:find-command|FindCommand]]| Search for existing command by name| |[[scripting:api:application:find-ex|FindEx]]| Find text in a way similar to interactive search| |[[scripting:api:application:find-in-files|FindInFiles]]| Finds text in specific file or directory files| |[[scripting:api:application:find-in-files-all|FindInFilesAll]]| Finds all matches text in the document| |[[scripting:api:application:find-pane|FindPane]]| Find existing tool pane| |[[scripting:api:application:find-short-key|FindShortKey]]| Search for existing ShortKey handler| |[[scripting:api:application:get-document|GetDocument]]| Returns opened document, if one exist| |[[scripting:api:application:get-file-name-color|GetFileNameColor]]| Returns color associated with provided file name| |[[scripting:api:application:get-icon-default-size|GetIconDefaultSize]]| Returns default image size (width is equal to height)| |[[scripting:api:application:get-storage|GetStorage]]| Returns storage object| |[[scripting:api:application:get-undo-action-description|GetUndoActionDescription]]| Returns description, associated with Undo Action type, if provided type registered| |[[scripting:api:application:get-user-configurations|GetUserConfigurations]]| User configurations. SAFEARRAY of BSTR| |[[scripting:api:application:get-user-variable|GetUserVariable]]| Read user variable value by name| |[[scripting:api:application:get-user-variables|GetUserVariables]]| User variables (global, workspace, project). SAFEARRAY of BSTR| |[[scripting:api:application:list|List]]| Return list pane by name| |[[scripting:api:application:md5|md5]]| Creates a MD5 hash from string| |[[scripting:api:application:navigate|Navigate]]| Navigates to position in document, opening it if necessary| |[[scripting:api:application:new-file|NewFile]]| Creates a new file and returns reference to it| |[[scripting:api:application:new-file-ex|NewFileEx]]| Creates a new file of specific type and returns reference to it| |[[scripting:api:application:open-file|OpenFile]]| Opens an existing file with or w/o file dialog and returns reference to it| |[[scripting:api:application:open-file-ex|OpenFileEx]]| Opens an existing file with or w/o file dialog, using specific viewer (selected by document type) and returns reference to it| |[[scripting:api:application:open-help|OpenHelp]]| Opens Help for provided word (URL, chm) in internal/external browser| |[[scripting:api:application:open-url|OpenURL]]| Opens URL in the internal browser| |[[scripting:api:application:output|Output]]| Return output pane by name| |[[scripting:api:application:path-from-relative|PathFromRelative]]| Convert path from relative to full form| |[[scripting:api:application:path-to-relative|PathToRelative]]| Convert path to relative form| |[[scripting:api:application:point|Point]]| Creates Point Object| |[[scripting:api:application:position|Position]]| Creates Position Object| |[[scripting:api:application:progress|progress]]| Sets progress state| |[[scripting:api:application:prompt|Prompt]]| Displays a dialog box to enter a string with possible default value| |[[scripting:api:script-application:quit|Quit]]| Forces script execution to stop at any time| |[[scripting:api:script-application:range|Range]]| Range object constructor with support of variable arguments| |[[scripting:api:application:read_file|read_file]]| Reads file data as string or binary| |[[scripting:api:application:register-code-template|RegisterCodeTemplate]]| Register Code Template handler| |[[scripting:api:application:register-command|RegisterCommand]]| Register new command| |[[scripting:api:application:register-command-listener|RegisterCommandListener]]| Register listener for existing command by name| |[[scripting:api:application:register-completion-provider|RegisterCompletionProvider]]| Register code completion provider for syntax| |[[scripting:api:application:register-icon|RegisterIcon]]| Register Icon by Window Handle HANDLE_PTR| |[[scripting:api:application:register-image-bitmap|RegisterImageBitmap]]| Register Icon from Bitmap| |[[scripting:api:application:register-image-path|RegisterImagePath]]| Register Icon by path| |[[scripting:api:application:register-image-resource|RegisterImageResource]]| Register Icon from Application binary resource (can be bitmap, PNG or Icon of any size)| |[[scripting:api:application:register-image-string|RegisterImageString]]| Register inline Icon base64 encoded binary data| |[[scripting:api:script-application:register-macro-translator|RegisterMacroTranslator]]| Register macro translator| |[[scripting:api:script-application:register-options-page|RegisterOptionsPage]]| Registers Options page| |[[scripting:api:application:register-short-key|RegisterShortKey]]| Register ShortKey handler| |[[scripting:api:application:register-tool|RegisterTool]]| Register a tool| |[[scripting:api:application:register-variable|RegisterVariable]]| Register external variable (vValue can be explicit BSTR value or [[:scripting:api:variable-handler:start|IVariableHandler]]* callback)| |[[scripting:api:application:remove-auto-correction|RemoveAutoCorrection]]| Remove auto correction item| |[[scripting:api:application:replace-ex|ReplaceEx]]| Replace text in a way similar to interactive search| |[[scripting:api:application:resolve-file-name|ResolveFileName]]| Resolves incomplete file name| |[[scripting:api:application:save_file|save_file]]| Save file data| |[[scripting:api:application:select-files|SelectFiles]]| Displays Application File Save/Open dialog. SAFEARRAY of BSTR| |[[scripting:api:script-application:short-key|ShortKey]]| ShortKey constructor| |[[scripting:api:application:show-options|ShowOptions]]| Show options dialog| |[[scripting:api:application:show-search-dlg|ShowSearchDlg]]| Show search dialog| |[[scripting:api:application:sleep|sleep]]| Pauses execution for the specified time in milliseconds| |[[scripting:api:application:status|status]]| Sets status message| |[[scripting:api:application:storage|Storage]]| Creates initial storage object| |[[scripting:api:application:style|Style]]| Creates Style Object| |[[scripting:api:application:un-register-code-template|UnRegisterCodeTemplate]]| UnRegister Code Template handler| |[[scripting:api:application:un-register-command|UnRegisterCommand]]| UnRegister a command| |[[scripting:api:application:un-register-command-listener|UnRegisterCommandListener]]| UnRegister listener for existing command by instance| |[[scripting:api:application:un-register-completion-provider|UnRegisterCompletionProvider]]| UnRegister code completion provider for syntax by instance| |[[scripting:api:script-application:un-register-macro-translator|UnRegisterMacroTranslator]]| UnRegister macro translator| |[[scripting:api:script-application:un-register-options-page|UnRegisterOptionsPage]]| UnRegisters Options page| |[[scripting:api:application:un-register-short-key|UnRegisterShortKey]]| UnRegister ShortKey handler| |[[scripting:api:application:un-register-tool|UnRegisterTool]]| UnRegister a tool| |[[scripting:api:application:un-register-variable|UnRegisterVariable]]| UnRegister external variable| |[[scripting:api:application:update-all|UpdateAll]]| Update all open documents| |[[scripting:api:application:uuid_generate|uuid_generate]]| Generates new UUID| |[[scripting:api:script-application:variable|Variable]]| Built-in variable constructor| |[[scripting:api:application:wtoa|wtoa]]| Converts Unicode text to ASCII| #API ~~NOTOC~~