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. ====== IApplication ====== Scriptable object ===== Description ===== Application Object Interface ===== 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: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:application:settings|Settings]]| Global settings object| |[[scripting:api:application:shell|Shell]]| Shell Object| |[[scripting:api:application:version|Version]]| Application version| ===== Methods ===== ^Method^ Description^ |[[scripting:api:application:add-auto-correction|AddAutoCorrection]]| Add auto correction item| |[[scripting:api:application:add-pane|AddPane]]| Add new tool pane| |[[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:application:btoa|btoa]]| Creates a base-64 encoded ASCII string from a string of binary data| |[[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: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: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: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: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: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: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:application:wtoa|wtoa]]| Converts Unicode text to ASCII| ===== See Also ===== [[:scripting:api:plugin:application|IPlugin::Application]], [[:scripting:api:plugin:init|IPlugin::Init]], [[:scripting:api:script-application:start|IScriptApplication]] #API ~~NOTOC~~