https://docs.dopus.com/ 2026-05-18T01:46:30+00:00 https://docs.dopus.com/ https://docs.dopus.com/lib/exe/fetch.php?media=logo.png 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_objects:aboutdata&rev=1692398147&do=diff If a script add-in provides an OnAboutScript method, it is passed an AboutData object when invoked via the user clicking the About button in Preferences. intDialogListerTabDialog.window text/html 2025-07-04T04:27:47+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:activatelisterdata&rev=1751603267&do=diff If a script add-in implements the OnActivateLister event, the method receives an ActivateListerData whenever the window activation state of a Lister changes. boolTrueFalseListerListerstring shiftctrlaltlwinrwin none text/html 2023-11-08T01:01:03+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:activatetabdata&rev=1699405263&do=diff If a script add-in implements the OnActivateTab event, the method receives an ActivateTabData object whenever the activation state of a tab changes. boolTrueobject:TabTabobject:TabTabstring shiftctrlaltlwinrwin none text/html 2025-07-04T04:30:05+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:addbuttonhelper&rev=1751603405&do=diff The AddButtonHelper object is used to add dynamic buttons to a toolbar. It's obtained from the property of the AddButtonsData object. ArgumentsnoneButtonDataButtonDatanoneButtonDatanoneButtonDatanoneButtonData text/html 2025-07-04T04:27:26+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:addbuttonsdata&rev=1751603246&do=diff If a script add-in adds dynamic toolbar buttons via the the OnAddButtons event, the method receives an AddButtonsData object whenever it needs to generate or update the list of buttons. ArgsArgsAddButtonHelperAddButtonHelperstringstringListerViewer 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_objects:addcmddata&rev=1692398147&do=diff The AddCmdData object is passed to the OnAddCommands event in a script add-in. The script can use this to add internal commands using the AddCommand method. Argumentsnoneobject:ScriptCommandScriptCommand 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_objects:addcoldata&rev=1692398147&do=diff The AddColData object is passed to the OnAddColumns event in a script add-in. The script can use this to add columns using the AddColumn method. Argumentsnoneobject:ScriptColumnScriptColumnAdvanced Find text/html 2023-10-20T17:33:54+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:afterfolderchangedata&rev=1697823234&do=diff If a script add-in implements the OnAfterFolderChange event, the method receives an AfterFolderChangeData object once the folder read is complete. stringnormalrefreshrefreshsearchrefreshsubparentrootbackforwarddblclk refreshsubobject:PathIf the read failedPath If the read was successful, this property is not provided text/html 2023-11-25T01:53:15+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:alias&rev=1700877195&do=diff An Alias object represents a defined folder alias. It is retrieved by enumerating or indexing the Aliases object. <default value>stringobject:PathPathboolTrueFalse text/html 2023-11-25T01:53:24+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:aliases&rev=1700877204&do=diff The Aliases object holds a collection of all the defined folder aliases. It is retrieved from the DOpus.aliases method. <default value>collection:AliasAliasesDOpus.Output(DOpus.aliases("desktop").path); Arguments nonenotnonenonenoneAliasesDOpus.aliasesFavorites ADD=alias 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_objects:args&rev=1692398147&do=diff Args The Args object is passed to a script when it is invoked via a command, via the Func.args property. It is used when a command added by a script has a command line template and provides access to any arguments provided on the command line. <argument name>variantArgsNAME/K,SIZE/N 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_objects:audiocoverart&rev=1692398147&do=diff The AudioCoverArt object provides access to an audio file's embedded cover art. It is obtained through the AudioMeta.coverart property. <default value>stringartistbackbandbandlogocolorfulfishcomposerconductorfronticonillustrationleadartistleafletlocationlyricist 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_objects:audiometa&rev=1692398147&do=diff The AudioMeta object is retrieved from the Metadata.audio or Metadata.audio_text properties. It provides access to metadata relating to sound files. <column keyword>variantMusicKeywords for Columnscollection:AudioCoverArtAudioCoverArt text/html 2023-10-20T17:33:37+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:beforefolderchangedata&rev=1697823217&do=diff If a script add-in implements the OnBeforeFolderChange event, the method receives a BeforeFolderChangeData object before the new folder is read. stringnormalrefreshrefreshsearchrefreshsubparentrootbackforwarddblclk refreshsubboolTrueobject:PathPathstring shiftctrlaltlwinrwin noneobject:TabTab 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_objects:blob&rev=1692398147&do=diff A Blob object represents a chunk of binary data. Scripting languages like VBScript and JScript have no built-in support for binary data - this object can be used to allocate a chunk of memory and manipulate it in a similar way to low-level languages like C. You can use 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_objects:busyindicator&rev=1692398147&do=diff A BusyIndicator object lets you control the breadcrumbs bar busy indicator from your script. By default a busy indicator simply indicates that something is happening; it can also be used to indicate the progress of a job (percentage complete from 0% to 100%). The user can click the spinning circle to see a description of the jobs that are running, and each job can optionally allow the user to abort it by displaying an text/html 2025-07-04T05:19:43+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:buttoncontext&rev=1751606383&do=diff The ButtonContext object is used to update the context-sensitive state of a script command button. It's obtained from the property of the ButtonContextData object. boolTrueboolTrueboolTrue text/html 2025-07-04T05:19:00+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:buttoncontextdata&rev=1751606340&do=diff If a script add-in adds commands that require context-sensitive state information via the the OnButtonContext event, the method receives a ButtonContextData object whenever it needs to supply state information for a button. ArgsArgsstringButtonContextButtonContextstringListerViewer text/html 2026-03-19T05:30:14+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:buttondata&rev=1773898214&do=diff The ButtonData object is used to initialise a dynamic toolbar button. It's obtained from the various methods of the AddButtonHelper object. The properties of this object are used to configure the button. Common to all types stringstringstringstringstringboolTrue 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_objects:clickdata&rev=1692398147&do=diff The ClickData object is passed to the OnClick method in a script function. object:FuncFunc text/html 2024-06-28T02:57:18+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:clipboardchangedata&rev=1719543438&do=diff If a script add-in implements the OnClipboardChange event, the method receives a ClipboardChangeData object whenever the system clipboard contents change. intboolTrue 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_objects:closelisterdata&rev=1692398147&do=diff If a script add-in implements the OnCloseLister event, the method receives a CloseListerData object before a Lister is closed. object:ListerListerboolTruestring shiftctrlaltlwinrwin noneboolTrue 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_objects:closetabdata&rev=1692398147&do=diff If a script add-in implements the OnCloseTab event, the method receives a CloseTabData object when a tab is closed. string shiftctrlaltlwinrwin noneobject:TabTab 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_objects:column&rev=1692398147&do=diff The Column object represents an information column displayed in a tab (e.g. name, size, attributes, etc). A collection of Column objects can be retrieved from the Format.columns property. <default value>stringboolTrueautoboolTruecollapseboolTrueexpandbool text/html 2023-12-06T06:09:38+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:columnvalue&rev=1701842978&do=diff The ColumnValue object represents a selected cell in a Tab. A collection of these is returned as a HighlightedColumns object from the Item.highlighted property. stringstringstring text/html 2025-12-01T06:42:18+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:command&rev=1764571338&do=diff The Command object is used by a script to run Opus commands. Any command that you can run from a button or hotkey you can run from a script - a script can even run commands added by other scripts. Fundamentally, using the Command object is similar to configuring an Opus button. You add one or more command lines to the object just the same as you add one or more command lines to a button's function. You can tell it which files and folders to act upon, and you can use the various methods and prope… text/html 2024-07-25T10:54:11+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:configbackupdata&rev=1721904851&do=diff If a script add-in implements the OnConfigBackup event, the method receives a ConfigBackupData object when the Opus configuration is backed up. objectPathobjectPathstring 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_objects:configchangedata&rev=1692398147&do=diff If a script add-in implements the OnScriptConfigChange event, the method receives a ConfigChangeData object whenever the user modifies the script's configuration via the Preferences editor. VectorstringVector text/html 2024-07-25T10:54:24+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:configrestoredata&rev=1721904864&do=diff If a script add-in implements the OnConfigRestore event, the method receives a ConfigRestoreData object when the configuration is restored from a backup. This method will be called twice; once before the restore begins, and once after Opus has restarted with the new configuration. The text/html 2026-05-13T07:35:35+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:control&rev=1778657735&do=diff The Control object represents a control on a script dialog; it lets you read and modify a control's value (and contents). Use the Dialog.Control method to obtain a Control object. string#RRGGBBRRR,GGG,BBBstatic textmarkup textbuttonlist viewstringeditupperlowernormal 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_objects:customfielddata&rev=1692398147&do=diff The CustomFieldData object is provided to a rename script via the GetNewNameData.custom property. It provides access to the value of any custom fields that your script added to the Rename dialog. variantCustomFieldDataOnGetCustomFieldsGetCustomFieldData.fieldsRename * Boolean options (True or False) - the variable type must be text/html 2025-10-21T03:32:59+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:date&rev=1761017579&do=diff The Date object is provided to make it easier to deal with variables representing dates. It converts automatically to an ActiveX VT_DATE value and so can function as a drop-in replacement for a scripting language's native date variables. The main advantage is that it retains milliseconds, unlike text/html 2025-03-25T06:16:41+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:deletescriptdata&rev=1742883401&do=diff If a script add-in implements the OnDeleteScript event, the method receives a DeleteScriptData object when the script is deleted by the user. string text/html 2026-05-14T02:33:35+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:dialog&rev=1778726015&do=diff The Dialog object allows you to display dialogs that prompt the user for confirmation, allow them to input text strings or passwords, and select checkbox options or choose from a drop-down list. You can also use this object to display a popup menu on screen. text/html 2024-08-16T03:32:54+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:dialoglistcolumn&rev=1723779174&do=diff The DialogListColumn object represents a column in a Details mode list view control in a script dialog. Use the Control.columns property to obtain a DialogListColumns object, and then enumerate it to obtain individual DialogListColumn objects.  stringstringboolTrueint1-10int-1DialogListColumns.AutoSize text/html 2025-06-23T14:07:28+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:dialoglistcolumns&rev=1750687648&do=diff The DialogListColumns object lets you query or modify the columns in a Details mode list view control in a script dialog. Use the Control.columns property to obtain a DialogListColumns object. You can enumerate this object to query the current columns. Each column is represented by a 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_objects:dialoglistgroup&rev=1692398147&do=diff The DialogListGroup object represents a group in a list view control in a script dialog. It's returned by the Control.GetGroupById method. boolControl.AddGroupintstring text/html 2025-10-21T02:17:37+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:dialoglistitem&rev=1761013057&do=diff The DialogListItem object represents an item in a combo box, list box or list view control in a script dialog. It's returned by the Control.GetItemAt and Control.GetItemByName methods. string#RRGGBBRRR,GGG,BBB list viewintlist view 012345intboollist viewlist viewstring#RRGGBB text/html 2025-01-31T18:20:05+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:dialoglistsubitem&rev=1738347605&do=diff The DialogListSubItem object represents a subitem of a DialogListItem in a Details mode list view control in a script dialog. Use the DialogListItem.subitems property to obtain a DialogListSubItems object, and then enumerate it to obtain individual DialogListSubItem objects.  <default> stringstringstring text/html 2025-01-09T03:46:51+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:dialoglistsubitems&rev=1736394411&do=diff The DialogListSubItems object lets you query or modify the subitems belonging to a DialogListItem. Use the property to obtain this object from a list view item in a script dialog. You can enumerate this object to query the subitems. Each subitem is represented by a 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_objects:dialogoption&rev=1692398147&do=diff The DialogOption object is used with the options property of the Dialog object. A collection of five of these is provided, and any you initialize will be displayed to the user as physical checkbox controls. stringboolDialog.Show 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_objects:displaymodechangedata&rev=1692398147&do=diff If a script add-in implements the OnDisplayModeChange event, the method receives a DisplayModeChangeData object when the display mode is changed in a tab. stringstringlargeiconssmalliconslistdetailspowerthumbnailstilesstring shiftctrlaltlwinrwin noneobject:TabTab 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_objects:dock&rev=1692398147&do=diff A collection of Dock objects is accessed from the Toolbar.docks property. It corresponds to a currently open floating toolbar. <default value>int 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_objects:docmeta&rev=1692398147&do=diff The DocMeta object is retrieved from the Metadata.doc or Metadata.doc_text properties. It provides access to metadata relating to document files. <column keyword>variantDocumentsKeywords for Columns text/html 2026-05-13T07:40:28+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:dopus&rev=1778658028&do=diff The DOpus object is one of the two global script objects provided by Opus, and is available to all scripts. It provides various helper methods, and collections that let you access things like Listers and toolbars. object:AliasesAliases folder aliasescollectionFormatFormatobject:FavoritesFavorites objectFiletypeGroupsFiletypeGroupsfile type groupsobject: text/html 2026-04-15T05:11:50+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:dopusfactory&rev=1776229910&do=diff The DOpusFactory object is a helper object that you can use to create various other objects. Unlike the objects that represent existing things (e.g. Lister or Tab), the objects created by DOpusFactory are independent objects that you can instantiate whenever you need their functionality. The 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_objects:doubleclickdata&rev=1692398147&do=diff If a script add-in implements the OnDoubleClick event, the method receives a DoubleClickData object when the user double-clicks a file or folder. boolFalseOnDoubleClickboolFalseboolTrueOnDoubleClickpathItemScriptInitData.early_dblclkTrueTrueskipfullTrueItemboolTrueFalseobject:ItemItemearlyFalsestringleftmiddlenoneboolTrueobject: 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_objects:dpi&rev=1692398147&do=diff The DPI object is a helper object that provides a number of methods and properties relating to the system DPI setting. For example, you can use it to convert a pixel width into one scaled for the current system DPI. The DPI object is returned via the text/html 2025-07-23T12:05:23+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:drive&rev=1753272323&do=diff The Drive object provides information about a drive (hard drive, CD ROM, etc) on your system. You can obtain a Vector of Drive objects, one for each drive on your system, from the FSUtil.Drives method. You can also get a Drive object from the Path.GetDrive method. text/html 2025-10-21T03:56:33+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:everythinginterface&rev=1761018993&do=diff If Everything by voidtools is installed, this provides an interface that lets you easily communicate with Everything from a script. You can start and stop Everything, query its status, send it arbitrary commands and query its database. Create an EverythingInterface text/html 2024-07-04T05:54:53+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:everythingresult&rev=1720072493&do=diff Represents a single item returned in the result set from an Everything query. A Vector of these objects is returned by a call to the EverythingInterface.Query method. When you send a query to everything you can tell it what information to return. Only information you request will appear in the result items, so e.g. if you want the file size, you must request it when you send the query. text/html 2025-07-09T12:08:20+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:exemeta&rev=1752062900&do=diff The ExeMeta object is retrieved from the Metadata.exe or Metadata.exe_text properties. It provides access to metadata relating to executable (program) files. <column keyword>variantProgramsKeywords for Columns Note that Signature (Authenticode) metadata is only present if the object was created in a context where the data was already known. (E.g. The 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_objects:favorite&rev=1692398147&do=diff A Favorite object represents a favorite folder. It is retrieved by enumerating or indexing the Favorites object. <default value>stringboolTrueFalseFavoritesFavoriteboolTrueobject:PathPath NameArgumentsnoneseparatorTrueFavorites.SavenoneFavorites.Save PathnoneFavorites.Save text/html 2023-08-17T06:32:19+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:favorites&rev=1692253939&do=diff The Favorites object holds a collection of all the defined favorite folders. It is retrieved from the DOpus.favorites property. <default value>collection:FavoriteFavoritesFavorite NameArguments Favoriteobject:Favorite object:FavoritesSavesep Favorites.Add("sep"); sep: Favorites.Add("sep:Current Job"); text/html 2025-10-21T04:01:35+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:faytclosedata&rev=1761019295&do=diff If a script add-in implements the OnFAYTClose event, the method receives an FAYTCloseData object when the FAYT closes (assuming it has been used with a script FAYT command). object:TabTab 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_objects:file&rev=1692398147&do=diff The File object lets you read and write binary data from and to a file on disk (or in a Zip file, FTP site, etc). While the Microsoft Scripting.FileSystemObject object lets you read and write files already, it only supports text, not binary data. You can also use the 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_objects:fileattr&rev=1692398147&do=diff The FileAttr object is provided to make it easier to deal with file attributes. Rather than dealing with attributes as a string of characters, or a number, it provides properties for each attribute that can be set or queried independently. You can create a new text/html 2024-11-18T06:53:41+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:filechange&rev=1731912821&do=diff The FileChange object provides information about a file changed by a command. If you set the Command.logchanges property to true, a collection of any file changes can be obtained from the Command.results property once the command is complete. string create text/html 2023-09-16T19:46:13+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:filegroup&rev=1694893573&do=diff The FileGroup object exposes information about a file group (when the file display is set to group by a particular column). The Tab.filegroups property returns a collection representing the current file groups in that tab, and the Item.filegroup property returns the current file group of a particular item. text/html 2025-11-12T14:17:55+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:fileoperationcompletedata&rev=1762957075&do=diff If a script add-in implements the OnFileOperationComplete event, the method receives a FileOperationCompleteData object whenever a supported file operation begins. If you return True to indicate that you want to be notified about the operation, you'll receive another call when the operation is complete. 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_objects:filesize&rev=1692398147&do=diff The FileSize object is provided to make it easier to deal with variables representing file sizes. It's very common these days for files to be larger than 4GB but unfortunately ActiveX scripting does not have proper support for the 64-bit integers needed to represent such large numbers. Therefore, any time a file size or number representing a number of bytes is returned by the Opus scripting objects, it is as a 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_objects:filesystemchangedata&rev=1692398147&do=diff A script add-in can monitor file and folder changes by implementing the OnFilesystemChange event and calling the FSUtil.WatchChanges method to establish monitoring. stringFSUtil.WatchChanges text/html 2023-09-16T19:44:46+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:filetypegroup&rev=1694893486&do=diff The FiletypeGroup object represents a file type group (as configured in the File Type Groups section of the file type editor). You can find out which groups a file belongs to by querying the Item.groups property, or by using the FiletypeGroups object. Note: If you're looking for information on how the file display is grouping an item based on one of the displayed columns, rather than which 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_objects:filetypegroups&rev=1692398147&do=diff The FileTypeGroups object represents a collection of FiletypeGroup objects. The object can be enumerated to retrieve the groups it represents. You can obtain an object representing all the configured file type groups from the DOpus.filetypegroups property. The Item.groupsobject property returns a text/html 2025-07-04T01:54:27+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:filter&rev=1751594067&do=diff The Filter object lets you create a textual filter of the type used by the Find tool and commands such as Copy to control recursive operations. Use the DOpusFactory.Filter method to create a new filter object. Once you have a Filter object you can: * Use the Item.MatchFilter text/html 2023-11-26T20:51:38+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:filterparseerror&rev=1701031898&do=diff If a Filter object fails to parse the textual filter string you provide, you can retrieve this object from the Filter.lasterror property to find out what went wrong. intstringintstring 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_objects:flatviewchangedata&rev=1692398147&do=diff If a script add-in implements the OnFlatViewChange event, the method receives a FlatViewChangeData object when the Flat View mode is changed in a tab. stringstringoffgroupedmixedmixednofoldersstring shiftctrlaltlwinrwin noneobject:TabTab 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_objects:folderenum&rev=1692398147&do=diff The FolderEnum object is returned from the FSUtil.ReadDir method. It lets you enumerate (optionally, recursively) the contents of a folder. boolTrueFalseint ArgumentsnonenonecompleteTrue Vectorobject:Itemobject:VectorItemVectorItem-1VectorVector 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_objects:fontmeta&rev=1692398147&do=diff The FontMeta object is retrieved from the Metadata.font property. It provides access to metadata relating to font files. The fields in this object correspond to those in the Windows SDK LOGFONT structure; further information about their meaning can be found on the text/html 2025-05-08T05:42:32+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:format&rev=1746682952&do=diff The Format object represents the current display format of a tab. It is obtained from the Tab.format property. boolTrueFalseboolTrueFalseboolTruecheckbox modeFalsecollection:ColumnColumnVectorstringVectorPathpathPathintstringdefaultonoffstringstringnormalneverotherboolTrueNever combinegroup_combine text/html 2026-05-13T07:31:30+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:fsutil&rev=1778657490&do=diff The FSUtil object provides several utility methods for dealing with the file system. It is obtained using the DOpus.FSUtil method. ArgumentsnoneWatchChangesid boolTrueFalseflags cMakes the path comparison case sensitive.pReturns True if path2 is equal to or a text/html 2024-08-16T03:24:14+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:func&rev=1723778654&do=diff Func The Func object is passed to a script when it is invoked via a command. In a script function, it is passed to the OnClick method as the ClickData.func property, and in a script add-in that adds an internal command, via the ScriptCommandData.func property. The Func object provides information about the default source and destination of the command, as well as details about how it was invoked. text/html 2023-11-25T01:55:25+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:getcopyqueuenamedata&rev=1700877325&do=diff If a script add-in implements the OnGetCopyQueueName event, the method receives a GetCopyQueueNameData object whenever a copy operation begins that uses automatically-managed copy queues (i.e. the Automatically manage file copy queues option on the Copying Files page in Preferences is turned on). 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_objects:getcustomfielddata&rev=1692398147&do=diff If a rename script implements the OnGetCustomFields event, the method receives a GetCustomFieldData object whenever the Rename dialog runs the script. object:CustomFieldDataCustomFieldDataRenameobject:MapRenameMapDOpusFactory.Mapobject:MapMapDOpusFactory.Mapstring!oldname!newname 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_objects:gethelpcontentdata&rev=1692398147&do=diff If a script implements the OnGetHelpContent event, it receives a GetHelpContentData object when the method is called. You can use the methods of this object to add your help content to the Directory Opus F1 help system. Arguments Blob none.png.jpgmyimage.jpg <img src="myimage.jpg"> text/html 2023-09-15T00:35:47+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:getnewnamedata&rev=1694738147&do=diff If a rename script is implemented using the OnGetNewName method, it receives a GetNewNameData object for each item being renamed. CustomFieldDataCustomFieldDatacustom fieldsRenameobject:ItemItemstringrename dialogstringstringstringNew Namestringstringstringrename dialogboolTrueFalseobject:TabTabFalse text/html 2026-03-19T04:45:43+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:globalfilters&rev=1773895543&do=diff The GlobalFilters object provides information about the global file and folder filter settings (configured on the Global Filters page in Preferences). It is obtained from the DOpus.filters property. boolTruestringregex:stringregex:boolTrueboolTruePermanentFiltersPermanentFiltersPermanent Filters text/html 2023-12-06T06:11:40+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:highlightedcolumns&rev=1701843100&do=diff The HighlightedColumns object lets you enumerate any selected cells belonging to an Item object. <default value>collection:ColumnValueColumnValue text/html 2026-05-13T07:32:40+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:httprequest&rev=1778657560&do=diff The HTTPRequest object lets you easily send an asynchronous HTTP request to a remote webserver and receive and process the response. This object is created via the Dialog object's method, and so requires a Script Dialog in order to use. The dialog also must be detached. The general process to use this object is as follows: text/html 2026-04-29T08:25:05+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:image&rev=1777451105&do=diff The Image object represents an image file or icon to be displayed in a script dialog. You can load an image or icon using the DOpus.LoadImage or Script.LoadImage methods. It can be displayed using a static control, a button control, assigned as the dialog's icon, or used as the icon for a listview item. 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_objects:imagemeta&rev=1692398147&do=diff The ImageMeta object is retrieved from the Metadata.image or Metadata.image_text properties. It provides access to metadata relating to picture files. <column keyword>variantPicturesKeywords for Columns text/html 2023-08-21T02:31:43+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:includefileinitdata&rev=1692585103&do=diff If an include file implements the optional OnInitIncludeFile event, an IncludeFileInitData object is passed to it to let it provide information about itself. This is completely optional; include files still work without this method, but providing it gives you things like a description and copyright information, and minimum version requirements. text/html 2026-05-13T07:43:04+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:item&rev=1778658184&do=diff The Item object represents a file or folder displayed in a tab. You can obtain a collection of Item objects from the various methods of the Tab object. A collection of Item objects is also used with the Command object to specify the files or folders a command should operate on. Using the text/html 2023-08-18T04:16:43+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:items&rev=1692332203&do=diff The Items object lets you enumerate a collection of one or more Item objects. An Items object is retrieved from a number of methods and properties, including Dialog.Multi, DOpus.GetClip, Command.files and several others. <default value>collection:ItemItemboolItemsDialog.Multiresultresult 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_objects:lister&rev=1692398147&do=diff The Lister object represents an open Lister window. A collection of currently open Lister objects is available from the DOpus.listers property, and if a command results in a new Lister being opened, the Results object. object:TabTabintstringSet LISTERTITLEtitlestringobject: 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_objects:listerresizedata&rev=1692398147&do=diff If a script add-in implements the OnListerResize event, the method receives a ListerResizeData object whenever a Lister window is resized. stringstringresizeminimizemaximizerestore.object:ListerLister text/html 2025-10-21T03:34:46+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:listers&rev=1761017686&do=diff The Listers object is a collection of all currently open Listers. It can be obtained via the DOpus.listers property. Note: If you are looking for a window to use as the parent for a Dialog, you are probably looking in the wrong place. Scripts should not assume that text/html 2024-06-14T20:43:45+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:listeruichangedata&rev=1718397825&do=diff If a script add-in implements the OnListerUIChange event, the method receives a ListerUIChangeData object when various user interface elements are opened or closed in a Lister. stringstringdualtreemetapaneviewerutilityduallayoutmetapanelayoutviewerlayouttoolbarstoolbarsettoolbarsauto text/html 2025-06-12T11:01:18+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:map&rev=1749726078&do=diff The Map object is an associative container. It is similar to an array or vector (e.g. Vector) in that it can store one or more objects, but has the advantage of using a dictionary system to locate objects rather than numeric indexes. You can therefore insert or lookup objects using an arbitrary value (string, integer, date, etc.) as the key. (Note that keys are implicitly converted into strings, regardless of initial type.) text/html 2026-03-19T04:26:17+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:menu&rev=1773894377&do=diff A Menu object lets you create and display a popup menu. Menus can appear anywhere on your dialog (or anywhere on screen), and they can also appear attached to certain dialog controls (e.g. a dropdown button, or over a specific listview item). You create an initial text/html 2026-03-19T04:27:53+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:menuitem&rev=1773894473&do=diff The MenuItem object represents an item in a popup menu defined by a Menu. You can create a popup menu using the Dialog.CreateMenu method. MenuMenuMenu text/html 2026-03-19T04:30:05+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:menumultiselresults&rev=1773894605&do=diff The MenuMultiSelResults object is returned by the Menu.Show method when used to show a popup menu in multi-select mode. Vector text/html 2025-07-23T12:23:14+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:metadata&rev=1753273394&do=diff The Metadata object provides metadata information about a file or folder (metadata are things like the track number of a music file, the dimensions of an image, the author of a document, etc). You can obtain a Metadata object from the Item.metadata property if you have an text/html 2026-03-19T04:33:31+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:msg&rev=1773894811&do=diff The Msg object represents a script dialog input event message. It’s returned by the Dialog.GetMsg method which you call when running the message loop for a detached dialog. <default value>boolTrueFalsestringleftrightmiddleintcheckednewexisting 0unchecked1checked2indeterminate3unchecked/disabled 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_objects:openlisterdata&rev=1692398147&do=diff If a script add-in implements the OnOpenLister event, the method receives an OpenListerData object when invoked when a new Lister opens. boolFalseTrueOnOpenListerafterTrueobject:ListerListerstring shiftctrlaltlwinrwin none 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_objects:opentabdata&rev=1692398147&do=diff If a script add-in implements the OnOpenTab event, the method receives an OpenTabData object when invoked when a new tab is opened. string shiftctrlaltlwinrwin noneobject:TabTab text/html 2024-07-25T06:13:34+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:orderedmap&rev=1721888014&do=diff The OrderedMap object is an associative container and is identical to the Map object except for the ordering of items within the map. Whereas the regular Map object sorts items alphabetically by key, the OrderedMap preserves the order that items are added. You can create a new 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_objects:othermeta&rev=1692398147&do=diff The OtherMeta object is retrieved from the Metadata.other property. It provides access to miscellaneous information about the file or folder. stringintGetSizesintdircountintGetSizesintfilecountstringGetSizesstringintobject:PathPathstringstringunknownlinkfiledosfileurljunctionsoftlink text/html 2024-08-22T01:33:44+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:pairedfolder&rev=1724290424&do=diff The PairedFolder object is returned by the FSUtil.GetFolderPair method when you query for a folder's pair. Make sure you check the valid property before querying any others - if valid is False it means the folder had no pair, so none of the other properties will exist. text/html 2025-07-23T12:04:19+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:path&rev=1753272259&do=diff The Path object represents a file or folder path. Many objects have properties that return a Path - for example, Tab.path returns the current folder in a tab as a Path object. You can create a new Path object from a string (or another Path) using the text/html 2024-08-09T08:06:56+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:periodictimerdata&rev=1723190816&do=diff A script add-in can use the DOpus.SetTimer method to create timers, which will call your OnPeriodicTimer method at the rate you specify. string text/html 2026-03-19T04:47:32+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:permanentfilters&rev=1773895652&do=diff The PermanentFilters object provides information about the permanent file and folder filter settings (configured on the Permanent Filters page in Preferences). It is obtained from the GlobalFilters.permanent property. boolTruestringregex:stringregex: text/html 2024-08-19T07:20:07+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:powereventdata&rev=1724052007&do=diff A script add-in can implement the OnPowerEvent method to receive notifications of certain system power-related events. The PowerEventData object is passed as the single argument to this method. stringtypestring batteryThe remaining battery capacity has changed. The current battery capacity is provided in the 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_objects:progress&rev=1692398147&do=diff The Progress object lets you display and control a standard Directory Opus progress indicator dialog. This object can be obtained from the Command.progress property. The basic steps for using a Progress object are: * Initialize the fundamental properties. 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_objects:quickfilter&rev=1692398147&do=diff The QuickFilter object provides access to information about the quick filter state in a tab. It’s returned by the Tab.quickfilter property.   Property NameReturn TypeDescription<default value> string boolTrue boolTrueboolTrueboolTrue stringboolTrue text/html 2024-08-09T08:02:12+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:quickfilterchangedata&rev=1723190532&do=diff If a script add-in implements the OnQuickFilterChange event, the method receives a QuickFilterChangeData object when the quick filter is changed in a tab. object:TabTab text/html 2024-02-27T02:57:27+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:rect&rev=1709002647&do=diff The Rect object represents a rectangle (or, in some cases, something relating to a rectangle's four sides). The descriptions below give the properties' typical meanings. Where a method returns a Rect with different meanings, it will be noted in the documentation for that method. text/html 2024-11-18T06:48:36+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:results&rev=1731912516&do=diff The Results object provides information about the outcome of a function run by the Command object. It is obtained from the Command.results property. collection ofFileChangeFileChangeCommandintcollection ofTabTabcollection ofListerListercollection ofViewerViewer text/html 2025-08-25T06:03:15+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:runresults&rev=1756101795&do=diff This object represents the results of a command run via the method when told to wait for the command to finish. It allows you to capture the console output of an external command. intstringstdoutstringstderr text/html 2024-11-13T01:56:22+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:scheduledtimerdata&rev=1731462982&do=diff A script add-in can use the DOpus.SetScheduledTimer method to create timers, which will call your OnScheduledTimer method when the desired date/time is reached. string text/html 2025-12-08T12:21:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:script&rev=1765196509&do=diff The Script object is one of the two global script objects provided by Opus. This object is provided to script addins when their various event handlers are invoked (other than for the OnInit event). It provides information relating to the script itself. The Script object is tied to the text/html 2023-08-21T01:21:03+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:scriptcolorpair&rev=1692580863&do=diff A simple object that bundles two colors together (text and background). string#RRGGBBRRR,GGG,BBBstring#RRGGBBRRR,GGG,BBB text/html 2026-01-28T06:37:14+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:scriptcolumn&rev=1769582234&do=diff In a script's OnInit method it can call the ScriptInitData.AddColumn method to add custom columns to Opus. These columns can be displayed in file displays and infotips, and can be searched on using the Advanced Find function. Each call to AddColumn returns a ScriptColumn object that the script needs to initialize. text/html 2026-03-20T22:33:05+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:scriptcolumndata&rev=1774045985&do=diff The ScriptColumnData object is passed to the script-defined entry points for any custom columns added by a script add-in. The method name for these events is defined by the script itself, but generically it's referred to as OnScriptColumn. Note that the fields group, sort, type and value text/html 2025-07-04T02:01:29+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:scriptcommand&rev=1751594489&do=diff In a script's OnInit method it can call the ScriptInitData.AddCommand method to add commands to the Opus internal command set. Each call to AddCommand returns a ScriptCommand object that the script needs to initialize. stringtemplateOnButtonContextstringCustomizeCommands tabstringtemplateOnAddButtonsstring swant source folder (will still run without one) text/html 2023-08-21T01:34:57+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:scriptcommanddata&rev=1692581697&do=diff The ScriptCommandData object is passed to the script-defined entry points for any internal commands added by a script add-in. The method name for these events is defined by the script itself, but generically it's referred to as OnScriptCommand. stringfunc.argsstring boolFAYT extensionFalseobject:FuncFunc 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_objects:scriptconfig&rev=1692398147&do=diff The ScriptConfig object is accessed via the ScriptInitData.config and the Script.config properties. The ScriptInitData.config property allows a script (in its OnInit method) to specify what configuration properties it supports, and provide default values for them. The properties assigned in text/html 2024-07-25T05:50:19+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:scriptconfigchangedata&rev=1721886619&do=diff If a script add-in implements the OnScriptConfigChange event, the method receives a ScriptConfigChangeData object whenever the user modifies the script's configuration via the Preferences editor. VectorstringVector text/html 2024-02-27T02:54:59+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:scriptfaytcommand&rev=1709002499&do=diff When a script calls the ScriptInitData.AddCommand method to add commands to the Opus internal command set, the ScriptCommand object it retrieves provides a ScriptFAYTCommand object in the fayt property. You can initialise this object to create a command that extends the FAYT field. string#RRGGBBRRR,GGG,BBBtextcolor text/html 2023-12-07T20:46:55+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:scriptfaytcommanddata&rev=1701982015&do=diff The ScriptFAYTCommandData object is passed to the script-defined entry points for any script add-ins that extend the FAYT field. The method name for these events is defined by the script itself, but generically it's referred to as OnScriptFAYTCommand. stringstring boolFalsescript commandintflagsScriptFAYTCommandScript.UpdateFAYTFlagsstring text/html 2025-10-21T03:50:15+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:scriptinitdata&rev=1761018615&do=diff The ScriptInitData object is passed to the OnInit event in a script add-in. The script should initialize the various properties to identify itself, and can optionally add internal commands using the AddCommand method, and custom columns using the AddColumn method, before returning. object:ScriptConfigScriptConfigOrderedMap descSets a description string for the property. text/html 2025-05-08T05:41:19+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:scriptstrings&rev=1746682879&do=diff The ScriptStrings object is returned by the DOpus.strings property. It lets you access any strings defined via string resources. object:VectorVector Arguments string stringGetboolTrue text/html 2024-03-27T04:47:58+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:shellproperty&rev=1711514878&do=diff The ShellProperty object represents a shell property - an item of metadata for a file or folder that comes from Windows or third-party extensions (as opposed to metadata from Opus's native metadata system). The FSUtil.GetShellPropertyList method lets you retrieve a list of available shell properties. You can then use 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_objects:shutdowndata&rev=1692398147&do=diff If a script add-in implements the OnShutdown event, the method receives a ShutdownData object when invoked on Opus shutdown. boolTrueFalsestring shiftctrlaltlwinrwin none text/html 2024-07-29T07:30:05+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:signature&rev=1722238205&do=diff The Signature object is returned by the FSUtil.GetSignature method to provide information about the signature used to digitally sign an executable file. object:CertInfoobject:CertInfoobject:CertInfostringstringstringboolTruedateboolTrueboolTrueverifyTrue 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_objects:smartfavorite&rev=1692398147&do=diff A SmartFavorite object represents an entry for a folder in the SmartFavorites table. It is retrieved by enumerating or indexing the SmartFavorites object. object:PathPathintint 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_objects:smartfavorites&rev=1692398147&do=diff The SmartFavorites object lets you query the contents of the SmartFavorites table. It is retrieved from the DOpus.smartfavorites property. <default value>collection:SmartFavoriteSmartFavoritesSmartFavoriteintSmartFavoritesintSmartFavorites   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_objects:sortorder&rev=1692398147&do=diff The SortOrder object is returned by the Format.manual_sort_order property if manual sort mode is active. It lets you query and modify the sort order. Arguments object:VectorVectorVector noneVector noneResetOrder 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_objects:sourcedestdata&rev=1692398147&do=diff If a script add-in implements the OnSourceDestChange event, the method receives a SourceDestData object to indicate which tab's state changed. boolTrueboolTruesourcedeststring shiftctrlaltlwinrwin noneobject:TabTab text/html 2025-07-23T12:24:13+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:specialmeta&rev=1753273453&do=diff The SpecialMeta object is retrieved from the Metadata.special property. It provides access to any folder-specific properties. For example, in file collections you can access the property this way to see when an item was added to the collection. 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_objects:startupdata&rev=1692398147&do=diff If a script add-in implements the OnStartup event, the method receives a StartupData object when Opus starts up. This object currently has no defined methods or properties. text/html 2026-05-13T07:51:04+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:storedquery&rev=1778658664&do=diff A StoredQuery object represents a stored query collection. It is retrieved by with the property of the Item object. This object lets you read and modify the query's parameters. Changes you make to the object will be reflected in the stored query next time it is read or its contents refreshed. 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_objects:stringset&rev=1692398147&do=diff The StringSet object is container that stores one or more unique strings. It is similar to an array or vector (e.g. Vector) but has the advantage of using a dictionary system to locate strings rather than numeric indexes. You can therefore lookup strings much more quickly than by linearly searching a text/html 2026-01-28T06:28:58+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:stringtools&rev=1769581738&do=diff A StringTools object provides several utility methods for encoding and decoding strings. For example, you can use a StringTools object to Base64-encode a chunk of data, or decode a UTF-8 encoded message header. You can obtain a StringTools object using the 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_objects:styleselecteddata&rev=1692398147&do=diff If a script add-in implements the OnStyleSelected event, the method receives a StyleSelectedData object when the user chooses a new Lister style. object:ListerListerstring shiftctrlaltlwinrwin nonestring text/html 2025-07-23T12:09:58+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:sysinfo&rev=1753272598&do=diff The SysInfo object is created by the DOpusFactory.SysInfo method. It lets scripts access miscellaneous system information that may not be otherwise easy to obtain from a script. noneboolDarkModeAppsnoneboolnoneintstringint0regex:nonestringnoneintnone int:index 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_objects:systemsettingchangedata&rev=1692398147&do=diff If a script add-in implements the OnSystemSettingChange event, the method receives a SystemSettingChangeData object when various system settings change. string themeThe Windows theme (visual style) has changedcolorsetOpus has changed from light to dark mode or vice versaenvironment text/html 2026-04-15T05:14:17+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:tab&rev=1776230057&do=diff The Tab object represents a folder tab in a Lister (even if the tab control isn't currently displayed, a Lister always has at least one open tab). You can obtain a collection of Tab objects from a Lister object. Tab objects are also used with the Command and Func objects, and if a command results in new tabs being opened, the 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_objects:tabclickdata&rev=1692398147&do=diff If a script add-in implements the OnTabClick event, the method receives a TabClickData object when a tab is clicked with a qualifier key held down. string shiftctrlaltlwinrwin noneobject:TabTab 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_objects:tabgroup&rev=1692398147&do=diff The TabGroup object represents a folder tab group or a folder into which other tab groups can be organized. Individual TabGroup objects can be accessed or enumerated from the TabGroups object. boolTrueClose existing folder tabs when opening this groupfolderFalsestringfolder text/html 2025-03-04T13:08:27+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:tabgroups&rev=1741093707&do=diff The TabGroups object lets your script query and modify the configured Folder Tab Groups. You can obtain a TabGroups object from the DOpus.TabGroups property. The TabGroups object is a collection of TabGroup objects; you can enumerate it to discover the top-level tab groups and folders. Folders can also be enumerated to discover the tab groups and folders they contain, and so on. text/html 2025-06-09T13:42:05+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:tabgrouptabentry&rev=1749476525&do=diff The TabGroupTabEntry object represents a single folder tab. The folder tabs in a tab group can be enumerated via the TabGroupTabList object. DescriptionstringFormatintlinkedTabGroup.LinkUnlinkstringlinked"slave"stringlock"on""off""changes""reuse"stringobject:Path   Method NameArgumentsReturn TypeDescription 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_objects:tabgrouptablist&rev=1692398147&do=diff The TabGroupTabList object represents a list of folders that will open as file display tabs when the parent tab group is opened. You can obtain this object from the tabs, lefttabs and righttabs properties of the TabGroup object. The TabGroupsTabList object is a collection of TabGroupTabEntry objects; you can enumerate it to discover each folder tab. text/html 2025-01-09T03:43:09+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:tabstats&rev=1736394189&do=diff The TabStats object provides various information and statistics about the current folder displayed in a tab. Note that the Tab object provides two versions of this object. Tab.selstats takes Checkbox Mode into account, and in this mode the values of the "checked" and the "selected" properties will be the same. If the object was retrieved via 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_objects:toolbar&rev=1692398147&do=diff The Toolbar object represents a toolbar. Toolbar objects can represent a specific instance of a toolbar (open in a specific Lister), and can also represent the toolbar itself, on disk, that doesn't have to currently be open at all. * When retrieved from the 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_objects:toolbars&rev=1692398147&do=diff The Toolbars object lets you enumerate all the defined toolbars in your Directory Opus configuration (whether currently turned on or not). It's retrieved using the DOpus.Toolbars method. <default value>collection:ToolbarToolbarstring Vector:string !static Vector DOpus.toolbars.fdb(0) text/html 2024-07-02T04:08:13+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:unorderedset&rev=1719893293&do=diff The UnorderedSet object is container that stores one or more unique objects. It is similar to a StringSet except it can store variants of any type (rather than just strings), and the contents are not kept sorted (in fact, the order of set members is unspecified). Like a StringSet it uses a dictionary system to locate members rather than numeric indexes. You can therefore lookup members much more quickly than by linearly searching a text/html 2026-04-15T05:18:53+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:unresolvedfiles&rev=1776230333&do=diff The UnresolvedFiles object contains a subset of the items in a Tab object relating to file and folder lists. It is obtained from a Tab object and provides the same set of files in an unresolved state. This is mostly useful with file collections which normally return the resolved path - accessing through the unresolved objects will return the native coll: text/html 2026-04-15T05:21:03+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:unsortedfiles&rev=1776230463&do=diff The UnsortedFiles object contains a subset of the items in a Tab object relating to file and folder lists. It is obtained from a Tab object and provides the same set of files in an unsorted state. This is mostly useful with expanded sub-folders or FlatView mode, which normally depth-sort the returned files (deepest first) - accessing through the unsorted objects will return files in the order they appear in the file display. text/html 2025-04-08T01:04:50+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:var&rev=1744074290&do=diff Var The Var object represents an individual user or script-defined variable. Individual Var objects can be accessed or enumerated from the Vars object. <default value>variant stringVarVarVars boolTrueFalseVarsVarstringboolTrueFalsevariantVarboolintstringdate text/html 2025-07-24T13:35:32+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:vars&rev=1753364132&do=diff Vars The Vars object represents a collection of user and script-defined variables. There are a number of different sets of variables, with differing scopes. Some sets support persistent variables, that are saved and re-loaded from one session to the other. text/html 2025-09-24T12:33:48+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:vector&rev=1758717228&do=diff The Vector object is provided to address some short-comings in ActiveX scripting's array support. Some languages have better support than others for arrays, but the languages aren't consistent and some (like JScript) have incompatible arrays that Opus is unable to access at all. Therefore, any Opus scripting objects that take or return an array-like variable will use (or prefer to use) a 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_objects:version&rev=1692398147&do=diff The Version object is retrieved from the DOpus.version property. It provides information about the current version of Directory Opus. <default value>stringAboutintstringdopus.execollection:intstringcollection:intobjectWinVerWinVer ArgumentsboolTrue"11""11.3""11.3.1" 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_objects:videometa&rev=1692398147&do=diff The VideoMeta object is retrieved from the Metadata.video or Metadata.video_text properties. It provides access to metadata relating to movie files. <column keyword>variantMoviesKeywords for Columns text/html 2024-02-27T02:56:53+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:viewer&rev=1709002613&do=diff The Viewer object represents a standalone image viewer. A collection of Viewer objects is returned by the Viewers object, which is obtainable via the DOpus.viewers property. For functions launched from within a viewer (e.g. from its toolbar), the current Viewer object is provided by the 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_objects:viewereventdata&rev=1692398147&do=diff If a script implements the OnViewerEvent event, it receives a ViewerEventData object whenever certain events occur in a standalone image viewer.   string * create: A new viewer has been created. * destroy: A viewer window has been destroyed. * load: A new image has been loaded in a viewer. The text/html 2024-04-07T18:32:03+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:viewers&rev=1712514723&do=diff The Viewers object is a collection of all currently open standalone image viewers. It can be obtained via the DOpus.viewers property.   <default value>collection:Viewerobject:ViewerViewer ArgumentsnonenoneDOpus.viewersUpdate text/html 2025-08-25T05:53:36+00:00 Anonymous (anonymous@undisclosed.example.com) https://docs.dopus.com/doku.php?id=reference:scripting_reference:scripting_objects:wild&rev=1756101216&do=diff The Wild object allows a script to access the in-built pattern matching functions in Opus. Even though most ActiveX scripting languages have their own pattern matching support (usually via a regular expression system of some sort), you may wish to use the one that Opus provides for consistency with internal Opus functions. 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_objects:winver&rev=1692398147&do=diff The WinVer object is retrieved from the Version.winver property. It provides information about the current version of Windows. <default value>stringboolTrueboolTrueboolTrueboolTrueboolTrueboolTrueboolTrueboolTrueboolTrueboolTrueboolTrueboolTrueboolTruebool