https://docs.dopus.com/ 2026-05-18T06:45:17+00:00 https://docs.dopus.com/ https://docs.dopus.com/lib/exe/fetch.php?media=logo.png text/html 2023-11-25T01:51:29+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:onaboutscript&rev=1700877089&do=diff The OnAboutScript event can be implemented by a script add-in to display an "about" dialog to the user. It is triggered when the user clicks the About button for a script on the Script Management dialog. Method Name:Argument Type:AboutData Return Type:noneDescription:AboutData.window text/html 2023-08-18T22:35:47+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:onactivatelister&rev=1692398147&do=diff The OnActivateLister event can be implemented by a script add-in to receive notification whenever a Lister window becomes the active window, or loses activation to another window. Method Name:Argument Type:ActivateListerDataReturn Type:noneDescription:ActivateListerData.lister text/html 2023-11-08T00:30:26+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:onactivatetab&rev=1699403426&do=diff The OnActivateTab event can be implemented by a script add-in to receive a notification every time a tab becomes active (i.e. comes to the front of another tab in the same file display). Method Name:Argument Type:ActivateTabDataReturn Type:noneDescription:ActivateTabData.oldtab text/html 2025-07-04T02:19:54+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:onaddbuttons&rev=1751595594&do=diff The OnAddButtons event can be implemented by a script add-in to add dynamic buttons to toolbars and menus. Scripts do this by adding new internal commands to Opus, specifying one or more arguments that are used to generate dynamic buttons. For example, a function called might have an argument text/html 2024-09-29T14:20:33+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:onaddcolumns&rev=1727619633&do=diff The OnAddColumns event is called to allow your script add-in to add columns. Call the AddColData.AddColumn method once for each column you wish to add. Method Name:Argument Type:AddColDataReturn Type:noneDescription:OnAddColumnsadd columnsScript.InitColumns text/html 2023-08-18T22:35:47+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:onaddcommands&rev=1692398147&do=diff The OnAddCommands event is called to allow your script add-in to add internal commands. Call the AddCmdData.AddCommand method once for each command you wish to add. Method Name:Argument Type:AddCmdDataReturn Type:noneDescription:OnAddCommandsadd internal commands Script.InitCommands text/html 2023-08-18T22:35:47+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:onafterfolderchange&rev=1692398147&do=diff The OnAfterFolderChange event can be implemented by a script add-in that wants to be notified after a new folder has been read in a tab. Use the OnBeforeFolderChange event to receive notification before the folder is read. Method Name:Argument Type:AfterFolderChangeDataReturn Type:boolDescription:AfterFolderChangeData.tab text/html 2023-08-18T22:35:47+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:onbeforefolderchange&rev=1692398147&do=diff The OnBeforeFolderChange event can be implemented by a script add-in to receive notification before a new folder is read in a tab. Use the OnAfterFolderChange event if you want notification after a folder has been read. Method Name:Argument Type:BeforeFolderChangeDataReturn Type:bool text/html 2025-07-04T02:19:11+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:onbuttoncontext&rev=1751595551&do=diff The OnButtonContext event can be implemented by a script add-in that adds one or more new this by adding new internal commands to Opus. Individual command arguments can be flagged as needing context-sensitive state. For example, a function called might have an argument that should appear highlighted in certain situations. When the user adds the command text/html 2023-08-18T22:35:47+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:onclick&rev=1692398147&do=diff The OnClick event is the main entry point for a script function. Method Name:Argument Type:ClickDataReturn Type:noneDescription:script function ClickDataClickData.funcFunc OnClickOnClickClickData text/html 2024-06-28T02:45:59+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:onclipboardchange&rev=1719542759&do=diff The OnClipboardChange event can be implemented by a script add-in to receive notification whenever the contents of the system clipboard change. Method Name:Argument Type:ClipboardChangeDataReturn Type:noneDescription: text/html 2023-08-18T22:35:47+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:oncloselister&rev=1692398147&do=diff The OnCloseLister event can be implemented by a script add-in to receive notification whenever a Lister is closed. Method Name:Argument Type:CloseListerDataReturn Type:boolDescription:CloseListerData.listershutdownTrue FalseTrueFalse text/html 2023-08-18T22:35:47+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:onclosetab&rev=1692398147&do=diff The OnCloseTab event can be implemented by a script add-in to receive notification when a tab is closed in a Lister. Method Name:Argument Type:CloseTabDataReturn Type:boolDescription:CloseTabData.tabTrueFalsenotOnCloseListerCloseListerData.lister.tabs text/html 2024-07-25T05:53:26+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:onconfigbackup&rev=1721886806&do=diff The OnConfigBackup event can be implemented by a script add-in to receive notification when the Opus configuration is being backed up. Method Name:Argument Type:ConfigBackupDataReturn Type:noneDescription:ConfigBackupData.location text/html 2024-07-25T05:54:52+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:onconfigrestore&rev=1721886892&do=diff The OnConfigRestore event can be implemented by a script add-in to receive notification when the Opus configuration is being restored from a backup. Method Name:Argument Type:ConfigRestoreDataReturn Type:noneDescription:ConfigRestoreData.location text/html 2025-03-25T06:15:09+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:ondeletescript&rev=1742883309&do=diff The OnDeleteScript event can be implemented by a script add-in to receive notification when (if) it's deleted by the user via the Scripts management user interface. You might want to use this to cleanup any data files your script has created. Method Name:Argument Type: text/html 2023-08-18T22:35:47+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:ondisplaymodechange&rev=1692398147&do=diff The OnDisplayModeChange event can be implemented by a script add-in to receive notification whenever the user changes the display mode in a tab. Method Name:Argument Type:DisplayModeChangeDataReturn Type:noneDescription:DisplayModeChangeData.tabmode text/html 2023-08-18T22:35:47+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:ondoubleclick&rev=1692398147&do=diff The OnDoubleClick event can be implemented by a script add-in to receive notification when the user double-clicks on a file or folder in a tab. By default your event handler is passed an Item object corresponding to the item that was double-clicked. Because constructing an Item object may take some time (e.g. on a network drive) you have the option for your handler to be called twice - once with only the path to the item, and a second time (if desired) with the full text/html 2025-10-21T04:00:22+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:onfaytclose&rev=1761019222&do=diff The OnFAYTClose event can be implemented by a script add-in to receive notification when the FAYT closes (assuming it has been used with a script FAYT command). Method Name:Argument Type:FAYTCloseDataReturn Type:noneDescription:FAYTCloseDatatab text/html 2025-09-30T01:37:51+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:onfileoperationcomplete&rev=1759196271&do=diff The OnFileOperationComplete event can be implemented by a script add-in to receive notifications when certain file operations complete. Currently the only type of operation that supports this is the Rename command, but others may be added in the future. Receiving notifications is a two-step process each time: text/html 2023-08-18T22:35:47+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:onfilesystemchange&rev=1692398147&do=diff The OnFilesystemChange event can be implemented by a script add-in to receive notification when monitored files or folders change. Monitoring is established by calling the FSUtil.WatchChanges method. Method Name:Argument Type:FilesystemChangeDataReturn Type:noneDescription:id text/html 2023-08-18T22:35:47+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:onflatviewchange&rev=1692398147&do=diff The OnFlatViewChange event can be implemented by a script add-in to receive notification whenever the user changes the display mode in a tab. Method Name:Argument Type:FlatViewChangeDataReturn Type:noneDescription:FlatViewChangeData.tabmode text/html 2023-11-25T01:52:00+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:ongetcopyqueuename&rev=1700877120&do=diff The OnGetCopyQueueName event can be implemented by a script add-in to override the default copy queue behavior when the Automatically manage file copy queues option on the Copying Files page in Preferences is turned on. The event is passed the default copy queue name along with information relating to the copy operation. It can accept the default queue name, provide its own or disable queuing and run the operation immediately.  text/html 2023-08-18T22:35:47+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:ongetcustomfields&rev=1692398147&do=diff The OnGetCustomFields event can be implemented by a rename script to add custom fields to the Rename dialog. This lets you provide one or more controls that users can use to pass parameters to your script. Method Name:Argument Type:GetCustomFieldDataReturn Type:noneDescription:RenameRefresh text/html 2023-08-18T22:35:47+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:ongethelpcontent&rev=1692398147&do=diff The OnGetHelpContent event can be implemented by a script add-in to add its own help content to the Directory Opus local F1 help. You can add a single page of help, or multiple pages (in which case the first page becomes the "topic header" and all subsequent pages appear below it in the index). You can also add images which can be displayed in the help content. Note that script-added help is only possible if the user has local http help enabled (which is the default) - if the user has chosen to … text/html 2025-06-24T18:09:01+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:ongetnewname&rev=1750788541&do=diff The OnGetNewName event is one of the three alternate entry points for rename scripts. The other two events - Rename_GetNewName and Rename_GetNewName2, are deprecated and should only be used for backwards compatibility with Opus 10. Method Name:Argument Type: text/html 2023-08-18T22:35:47+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:oninit&rev=1692398147&do=diff The OnInit event is called once for each script add-in to initialize it. The event will be called on program startup, and also if a script is added or edited while Opus is already running. Implementing the OnInit event is optional, but highly recommended as it allows you to provide a name, description and other information to be shown to the user in Preferences. It also provides a way for a script to text/html 2023-08-21T02:34:16+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:oninitincludefile&rev=1692585256&do=diff The OnInitIncludeFile event is called once for each include file script to initialize it. Implementing this event is optional, but recommended as it allows you to provide a name, description and other information such as minimum version requirements. Method Name: text/html 2023-08-18T22:35:47+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:onlisterresize&rev=1692398147&do=diff The OnListerResize event can be implemented by a script add-in to receive notification whenever a Lister window is resized. Method Name:Argument Type:ListerResizeDataReturn Type:noneDescription:ListerResizeData.listeractionstringwidthheight text/html 2023-08-18T22:35:47+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:onlisteruichange&rev=1692398147&do=diff The OnListerUIChange event can be implemented by a script add-in to receive notification when the state of certain user interface elements in the Lister changes. Method Name:Argument Type:ListerUIChangeDataReturn Type:noneDescription:ListerUIChangeData.listerchangestringCommand.IsSet text/html 2023-08-18T22:35:47+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:onopenlister&rev=1692398147&do=diff The OnOpenLister event can be implemented by a script add-in to receive notification when a new Lister is opened. Method Name:Argument Type:OpenListerDataReturn Type:boolDescription:OpenListerData.listerTrue text/html 2023-08-18T22:35:47+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:onopentab&rev=1692398147&do=diff The On event can be implemented by a script add-in to receive notification when a new tab opens. Method Name:Argument Type:OpenTabDataReturn Type:noneDescription:OpenTabData.tabOnOpenLister text/html 2024-08-09T08:04:57+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:onperiodictimer&rev=1723190697&do=diff The OnPeriodicTimer event can be implemented by a script add-in to have Opus call your script at regular intervals. The DOpus.SetTimer method can be used to create timers, and your OnPeriodicTimer method will be called regularly for each timer you create. Method Name: text/html 2024-08-19T07:21:31+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:onpowerevent&rev=1724052091&do=diff The OnPowerEvent event can be implemented by a script add-in to have Opus notify your script whenever certain system power-related events occur. Method Name:Argument Type:PowerEventDataReturn Type:noneDescription:type text/html 2024-08-09T08:00:33+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:onquickfilterchange&rev=1723190433&do=diff The OnQuickFilterChange event can be implemented by a script add-in to receive notification when the quick filter changes within a tab. Method Name:Argument Type:QuickFilterChangeDataReturn Type:noneDescription:QuickFilterChangeData.tab text/html 2024-11-13T01:55:30+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:onscheduledtimer&rev=1731462930&do=diff The OnScheduledTimer event can be implemented by a script add-in to have Opus call your script at when a specific date/time is reached. The DOpus.SetScheduledTimer method can be used to create timers, and your OnScheduledTimer method will be called at most one time for each timer you create. text/html 2025-09-26T22:27:01+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:onscriptcolumn&rev=1758925621&do=diff The OnScriptColumn event is the entry point for a custom column added by a script add-in. The actual name of the event is defined by the script itself, when the column is added via the ScriptInitData.AddColumn method - OnScriptColumn is merely a placeholder name. Method Name:Argument Type: text/html 2025-01-20T04:26:27+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:onscriptcommand&rev=1737347187&do=diff The OnScriptCommand event is the entry point for an internal command added by a script add-in. The actual name of the event is defined by the script itself, when the command is added via the ScriptInitData.AddCommand method - OnScriptCommand is merely a placeholder name. Method Name:Argument Type: text/html 2024-07-25T05:50:38+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:onscriptconfigchange&rev=1721886638&do=diff The OnScriptConfigChange event can be implemented by a script add-in to receive notification whenever the user modifies the script's configuration via the Preferences editor. Method Name:Argument Type:ScriptConfigChangeDataReturn Type:noneDescription:ScriptConfigChangeData.changed text/html 2023-08-21T01:26:27+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:onscriptfaytcommand&rev=1692581187&do=diff The OnScriptFAYTCommand event is the entry point for a script add-in that extends the FAYT field. The actual name of the event is defined by the script itself, when the command is added via the ScriptInitData.AddCommand method - OnScriptFAYTCommand is merely a placeholder name. Method Name:Argument Type: text/html 2023-08-18T22:35:47+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:onshutdown&rev=1692398147&do=diff The OnShutdown event can be implemented by a script add-in to receive notification when Opus is shutting down. Method Name:Argument Type:ShutdownDataReturn Type:boolDescription:ShutdownData.endsessionTrueendsessionFalseTrue text/html 2023-08-18T22:35:47+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:onsourcedestchange&rev=1692398147&do=diff The OnSourceDestChange event can be implemented by a script add-in to receive notification whenever a tab's source/destination state changes. Method Name:Argument Type:SourceDestDataReturn Type:noneDescription:SourceDestData.tabsourcedestFalse text/html 2023-08-18T22:35:47+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:onstartup&rev=1692398147&do=diff The OnStartup event can be implemented by a script add-in to receive notification when Opus starts up. Method Name:Argument Type:StartupDataReturn Type:noneDescription:OnStartup text/html 2023-08-18T22:35:47+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:onstyleselected&rev=1692398147&do=diff The OnStyleSelected event can be implemented by a script add-in to receive notification when the user selects a new Lister style. Method Name:Argument Type:StyleSelectedDataReturn Type:noneDescription:StyleSelectedData.listerstyle text/html 2023-08-18T22:35:47+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:onsystemsettingchange&rev=1692398147&do=diff The OnSystemSettingChange event can be implemented by a script add-in to receive notification when various system settings change. Method Name:Argument Type:SystemSettingChangeDataReturn Type:noneDescription:SystemSettingChangeData.type text/html 2023-08-18T22:35:47+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:ontabclick&rev=1692398147&do=diff The OnTabClick event can be implemented by a script add-in to receive notification when a tab is clicked with a qualifier key held down. You can use this to override the default behavior (e.g. control-clicking tabs normally links them). Method Name:Argument Type: text/html 2023-08-18T22:35:47+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_events:onviewerevent&rev=1692398147&do=diff The OnViewerEvent event can be implemented by a script add-in to receive notification whenever certain events occur in the standalone image viewer. One possible use would be a script that automatically displays a floating toolbar whenever a standalone viewer is active, and hides it again when the window goes inactive or closes.