# Scripting Objects

Scripts can interact with Opus using a number of different objects. For example, the **Lister** object represents a physical [Lister](../../basic_concepts/the_lister) window, providing information about that Lister to the script and letting the script modify or control that Lister.

An object has two main types of interface that you can call on:

* _Properties_ let the script query (and sometimes set) a simple value. For example, the **Lister** object has a **title** property that lets the script retrieve the Lister window's title string.
* _Methods_ are functions an object provides that the script can invoke to perform a task. For example, the **DOpus** object has an **Output** method that lets the script output a text string to the script log.

The main distinction between properties and methods is that methods can (but don't always) accept arguments that modify their behavior, and don't have to (but often do) return a result.

## Variable types

Properties and methods that return a result can return a number of different types of variables, and methods often take one or more parameters that can also be a number of types. ActiveX scripting languages are generally _typeless_ - that is, a variable's type does not have to be defined in advance, and conversion from one type to another is often (but not always) automatic. Opus scripting mainly uses variables of the following types:

* _Int_ - a whole number (signed; valid range is -2147483648 to 2147483647).
* _Currency_ - this is a standard variant type, and is used by Opus in just a couple of cases that require numbers larger than an _Int_ can hold (unfortunately ActiveX scripting does not always support a 64 bit integer type).
* _Decimal_ - an unsigned 64 bit value (maximum value 18,446,744,073,709,551,616). Not all languages support this - JScript does, but VBScript does not.
* _String_ - a text string
* _Bool_ - a Boolean (either **True** or **False**)
* _Date_ - a date/time value
* _Collection_ - a collection of multiple objects of (generally) the same type. Collections can be easy enumerated in some languages (e.g. in VBScript, using the _For Each_ construct). Collections are only returned by Opus - unlike an array (or a Vector object), they are never created or modified directly (although some script methods can be used to modify them in certain cases). For example, the **Tab** object has a property called **selected** that represents all currently selected items in that tab - it is a _collection_ of items.
* _Object_ - an Opus script object with defined methods and properties (one of the object types listed below). Some objects can be both an object and a collection - that is, they have methods and properties, but can also be enumerated like a collection. Some objects also have a _default value_ - that is, simply using the object's name without any method or property will return a value of its own. For example, the **Metadata** object's default value is a string indicating the primary type of metadata available. You can also refer to an object's default value using the special **def\_value** property name.
* _Variant_ - a variable of any type (this is used with a few objects - for example, a **Var** object can store a variant)

## Global objects

There are two objects that are provided to scripts as global variables when they are invoked by Opus:

* [**DOpus**](scripting_objects/dopus): This\*\* \*\*object is available to _all_ scripts. It provides various helper methods, and collections that let you access things like Listers and toolbars.
* [**Script**](scripting_objects/script): This\*\* \*\*object is provided to [script add-ins](../../scripting/script_add-ins) when their various event handlers are invoked. It provides information relating to the script itself.

## Event objects

There are a number of objects that Opus provides as parameters to methods within a script. For example, when a [script function](../../scripting/script_functions) is invoked (e.g. when the button is clicked), Opus calls its **OnClick** method, passing it a **ClickData** object.

* [**AboutData**](scripting_objects/aboutdata): This object is provided to the [**OnAboutScript**](https://github.com/Chaoses-Ib/DirectoryOpus/blob/main/Manual/reference/scripting_reference/scripting_objects/scripting_events/onaboutscript.md) method, which is called when the user clicks the _About_ button for a script in the [**Script Management**](../../scripting/script_management) dialog.
* [**ActivateListerData**](scripting_objects/activatelisterdata): This object is provided to the [**OnActivateLister**](https://github.com/Chaoses-Ib/DirectoryOpus/blob/main/Manual/reference/scripting_reference/scripting_objects/scripting_events/onactivatelister.md) method, which is called whenever a Lister window is activated or deactivated.
* [**ActivateTabData**](scripting_objects/activatetabdata): This object is provided to the [**OnActivateTab**](https://github.com/Chaoses-Ib/DirectoryOpus/blob/main/Manual/reference/scripting_reference/scripting_objects/scripting_events/onactivatetab.md) method, which is called whenever a tab is activated.
* [**AddCmdData**](scripting_objects/addcmddata): This object is provided to the [**OnAddCommands**](https://github.com/Chaoses-Ib/DirectoryOpus/blob/main/Manual/reference/scripting_reference/scripting_objects/scripting_events/onaddcommands.md) method, which allows a script to [add new internal commands](../../scripting/example_scripts/adding_a_new_internal_command).
* [**AddColData**](scripting_objects/addcoldata): This object is provided to the [**OnAddColumns**](https://github.com/Chaoses-Ib/DirectoryOpus/blob/main/Manual/reference/scripting_reference/scripting_objects/scripting_events/onaddcolumns.md) method, which allows a script to [add new information columns](../../scripting/example_scripts/adding_a_new_column).
* [**AfterFolderChangeData**](scripting_objects/afterfolderchangedata): This object is provided to the [**OnAfterFolderChange**](https://github.com/Chaoses-Ib/DirectoryOpus/blob/main/Manual/reference/scripting_reference/scripting_objects/scripting_events/onafterfolderchange.md) method, which is called after a new folder has been read.
* [**BeforeFolderChangeData**](scripting_objects/beforefolderchangedata): This object is provided to the [**OnBeforeFolderChange**](https://github.com/Chaoses-Ib/DirectoryOpus/blob/main/Manual/reference/scripting_reference/scripting_objects/scripting_events/onbeforefolderchange.md) method, which is called before a new folder is read.
* [**ClickData**](scripting_objects/clickdata): This object is provided to the [**OnClick**](https://github.com/Chaoses-Ib/DirectoryOpus/blob/main/Manual/reference/scripting_reference/scripting_objects/scripting_events/onclick.md) method, which is called whenever a [script function](../../scripting/script_functions) is invoked (e.g. when the button is clicked or hotkey pressed).
* [**ClipboardChangeData**](scripting_objects/clipboardchangedata): This object is provided to the [**OnClipboardChange**](https://github.com/Chaoses-Ib/DirectoryOpus/blob/main/Manual/reference/scripting_reference/scripting_objects/scripting_events/onclipboardchange.md) method, which is called whenever the system clipboard contents change.
* [**CloseListerData**](scripting_objects/closelisterdata): This object is provided to the [**OnCloseLister**](https://github.com/Chaoses-Ib/DirectoryOpus/blob/main/Manual/reference/scripting_reference/scripting_objects/scripting_events/oncloselister.md) method, which is called before a Lister closes.
* [**CloseTabData**](scripting_objects/closetabdata): This object is provided to the [**OnCloseTab**](https://github.com/Chaoses-Ib/DirectoryOpus/blob/main/Manual/reference/scripting_reference/scripting_objects/scripting_events/onclosetab.md) method, which is called before a tab closes.
* [**ConfigBackupData**](scripting_objects/configbackupdata): This object is provided to the [**OnConfigBackup**](https://github.com/Chaoses-Ib/DirectoryOpus/blob/main/Manual/reference/scripting_reference/scripting_objects/scripting_events/onconfigbackup.md) method, which notifies a script before the Opus configuration is backed up.
* [**ConfigRestoreData**](scripting_objects/configrestoredata): This object is provided to the [**OnConfigRestore**](https://github.com/Chaoses-Ib/DirectoryOpus/blob/main/Manual/reference/scripting_reference/scripting_objects/scripting_events/onconfigrestore.md) method, which notifies a script when the Opus configuration is restored from a backup.
* [**DisplayModeChangeData**](scripting_objects/displaymodechangedata): This object is provided to the [**OnDisplayModeChange**](https://github.com/Chaoses-Ib/DirectoryOpus/blob/main/Manual/reference/scripting_reference/scripting_objects/scripting_events/ondisplaymodechange.md) method, which is called when the display mode changes in a tab.
* [**DoubleClickData**](scripting_objects/doubleclickdata): This object is provided to the [**OnDoubleClick**](https://github.com/Chaoses-Ib/DirectoryOpus/blob/main/Manual/reference/scripting_reference/scripting_objects/scripting_events/ondoubleclick.md) method, which is called when a file or folder is double-clicked.
* [**FileOperationCompleteData**](scripting_objects/fileoperationcompletedata): This object is provided to the [**OnFileOperationComplete**](https://github.com/Chaoses-Ib/DirectoryOpus/blob/main/Manual/reference/scripting_reference/scripting_objects/scripting_events/onfileoperationcomplete.md) method, which lets you receive notification when certain file operations complete.
* [**FilesystemChangeData**](scripting_objects/filesystemchangedata): This object is provided to the [**OnFilesystemChange**](https://github.com/Chaoses-Ib/DirectoryOpus/blob/main/Manual/reference/scripting_reference/scripting_objects/scripting_events/onfilesystemchange.md) method, after you've established monitoring for file or folder changes via the [**FSUtil**](scripting_objects/fsutil)**.WatchChanges** method.
* [**FlatViewChangeData**](scripting_objects/flatviewchangedata): This object is provided to the [**OnFlatViewChange**](https://github.com/Chaoses-Ib/DirectoryOpus/blob/main/Manual/reference/scripting_reference/scripting_objects/scripting_events/onflatviewchange.md) method, which is called when the Flat View mode changes in a tab.
* [**GetCopyQueueNameData**](scripting_objects/getcopyqueuenamedata): This object is provided to the [**OnGetCopyQueueName**](https://github.com/Chaoses-Ib/DirectoryOpus/blob/main/Manual/reference/scripting_reference/scripting_objects/scripting_events/ongetcopyqueuename.md) event, which is called whenever a copy operation begins that uses automatically-managed copy queues.
* [**GetCustomFieldData**](scripting_objects/getcustomfielddata): This object is provided to the \*\*[OnGetCustomFields](https://github.com/Chaoses-Ib/DirectoryOpus/blob/main/Manual/reference/scripting_reference/scripting_objects/scripting_events/ongetcustomfields.md)\*\*event, which lets a [rename script](../../scripting/rename_scripts) add its own fields to the _Rename_ dialog.
* [**GetNewNameData**](scripting_objects/getnewnamedata): This object is provided to the [**OnGetNewName**](https://github.com/Chaoses-Ib/DirectoryOpus/blob/main/Manual/reference/scripting_reference/scripting_objects/scripting_events/ongetnewname.md) method, which is one of the supported methods a [rename script](../../scripting/rename_scripts) can provide.
* [**ListerResizeData**](scripting_objects/listerresizedata): This object is provided to the [**OnListerResize**](https://github.com/Chaoses-Ib/DirectoryOpus/blob/main/Manual/reference/scripting_reference/scripting_objects/scripting_events/onlisterresize.md) event, which is called whenever a Lister window is resized.
* [**ListerUIChangeData**](scripting_objects/listeruichangedata): This object is provided to the [**OnListerUIChange**](https://github.com/Chaoses-Ib/DirectoryOpus/blob/main/Manual/reference/scripting_reference/scripting_objects/scripting_events/onlisteruichange.md) method, which is called when various user interface elements (tree, viewer, etc) are open or closed in a Lister.
* [**OpenListerData**](scripting_objects/openlisterdata): This object is provided to the [**OnOpenLister**](https://github.com/Chaoses-Ib/DirectoryOpus/blob/main/Manual/reference/scripting_reference/scripting_objects/scripting_events/onopenlister.md) method, which is called when a new Lister is opened.
* [**OpenTabData**](scripting_objects/opentabdata): This object is provided to the [**OnOpenTab**](https://github.com/Chaoses-Ib/DirectoryOpus/blob/main/Manual/reference/scripting_reference/scripting_objects/scripting_events/onopentab.md) method, which is called when a new tab is opened.
* [**ScriptColumnData**](scripting_objects/scriptcolumndata): This object is provided to the [script-specified method](../../scripting/example_scripts/adding_a_new_column) used to add new columns to Opus.
* [**ScriptCommandData**](scripting_objects/scriptcommanddata): This object is provided to the [script-specified method](https://github.com/Chaoses-Ib/DirectoryOpus/blob/main/Manual/reference/scripting_reference/scripting_objects/scripting_events/onscriptcommand.md) used to [add new internal commands](../../scripting/example_scripts/adding_a_new_internal_command) to Opus.
* [**ScriptConfigChangeData**](scripting_objects/scriptconfigchangedata): This object is provided to the [**OnScriptConfigChange**](https://github.com/Chaoses-Ib/DirectoryOpus/blob/main/Manual/reference/scripting_reference/scripting_objects/scripting_events/onscriptconfigchange.md) method, which notifies a script when the user edits the script's configuration.
* [**ScriptFAYTCommandData**](scripting_objects/scriptfaytcommanddata): This object is provided to the [script-specified method](https://github.com/Chaoses-Ib/DirectoryOpus/blob/main/Manual/reference/scripting_reference/scripting_objects/scripting_events/onscriptcommand.md) used to [extend the FAYT field](../../scripting/example_scripts/extending_the_fayt).
* [**ScriptInitData**](scripting_objects/scriptinitdata): This object is provided to the [**OnInit**](https://github.com/Chaoses-Ib/DirectoryOpus/blob/main/Manual/reference/scripting_reference/scripting_objects/scripting_events/oninit.md) method, which is called once to initialize each script in the _Script Addins_ folder.
* [**ShutdownData**](scripting_objects/shutdowndata): This object is provided to the [**OnShutdown**](https://github.com/Chaoses-Ib/DirectoryOpus/blob/main/Manual/reference/scripting_reference/scripting_objects/scripting_events/onshutdown.md) method, which is called before Opus shuts down.
* [**SourceDestData**](scripting_objects/sourcedestdata): This object is provided to the [**OnSourceDestChange**](https://github.com/Chaoses-Ib/DirectoryOpus/blob/main/Manual/reference/scripting_reference/scripting_objects/scripting_events/onsourcedestchange.md) method, which is called when the source or destination state of a tab changes.
* [**StartupData**](scripting_objects/startupdata): This object is provided to the [**OnStartup**](https://github.com/Chaoses-Ib/DirectoryOpus/blob/main/Manual/reference/scripting_reference/scripting_objects/scripting_events/onstartup.md) method, which is called when Opus starts up.
* [**StyleSelectedData**](scripting_objects/styleselecteddata): This object is provided to the [**OnStyleSelected**](https://github.com/Chaoses-Ib/DirectoryOpus/blob/main/Manual/reference/scripting_reference/scripting_objects/scripting_events/onstyleselected.md) method, which is called when a new [style](../../basic_concepts/the_lister/styles) is chosen in a Lister.
* [**SystemSettingChangeData**](scripting_objects/systemsettingchangedata): This object is provided to the [**OnSystemSettingChange**](https://github.com/Chaoses-Ib/DirectoryOpus/blob/main/Manual/reference/scripting_reference/scripting_objects/scripting_events/onsystemsettingchange.md) method, which is called when various system settings change.
* [**TabClickData**](scripting_objects/tabclickdata): This object is provided to the [**OnTabClick**](https://github.com/Chaoses-Ib/DirectoryOpus/blob/main/Manual/reference/scripting_reference/scripting_objects/scripting_events/ontabclick.md) event, which is called whenever a tab is clicked with a qualifier key held down.
* [**ViewerEventData**](scripting_objects/viewereventdata): This object is provided to the [**OnViewerEvent**](https://github.com/Chaoses-Ib/DirectoryOpus/blob/main/Manual/reference/scripting_reference/scripting_objects/scripting_events/onviewerevent.md) event, which is called whenever certain events occur in a standalone [image viewer](../../additional_functionality/viewing_images).

## Other objects

The remaining objects are all obtained using methods or properties provided by the objects listed above. For example, a **Lister** object is obtained using the **DOpus.listers** collection property, and a **Vector** object is obtained using the **DOpusFactory.Vector** method.

* [**Alias**](scripting_objects/alias): This object represents a [folder alias](../../basic_concepts/the_lister/navigation/aliases), and is retrieved using the **Aliases** object.
* [**Aliases**](scripting_objects/aliases): This object is a collection of all defined folder aliases. It is retrieved using the **DOpus.aliases** collection property.
* [**Args**](scripting_objects/args): This object represents the arguments supplied on the command line for [script-defined internal commands](../../scripting/example_scripts/adding_a_new_internal_command). It is retrieved from the **ScriptCommandData.Func.args** property.
* [**AudioMeta**](scripting_objects/audiometa): This object provides metadata properties relating to audio files. It is obtained from the **Metadata** object.
* [**AudioCoverArt**](scripting_objects/audiocoverart): This object provides access to an audio file's embedded cover art. It is obtained from the **AudioMeta.coverart** property.
* [**Blob**](scripting_objects/blob): This object provides a simple interface for dealing with binary data. It is obtained from the **DOpusFactory.Blob** method and also returned by the **AudioCoverArt.data** property.
* [**BusyIndicator**](scripting_objects/busyindicator): A **BusyIndicator** object lets you control the breadcrumbs bar busy indicator from your script.
* [**Column**](scripting_objects/column): This object represents a column that has been added to the display in a tab. A collection of columns can be obtained from the **Format** object.
* [**Command**](scripting_objects/command): This object is used to run Opus commands. It is obtained from the **ScriptCommandData.func** or **ClickData.func** properties, and can also be created by the **DOpusFactory.Command** method.
* [**Control**](scripting_objects/control): The **Control** object represents a control on a [script dialog](../../scripting/script_dialogs); it lets you read and modify a control's value (and contents).
* [**CustomFieldData**](scripting_objects/customfielddata): The **CustomFieldData** object is provided to a [rename script](../../scripting/rename_scripts) via the [**GetNewNameData**](scripting_objects/getnewnamedata)**.custom** property. It provides access to the value of any [custom fields](../../scripting/rename_scripts/custom_fields_in_the_rename_dialog) that your script added to the _Rename_ dialog.
* [**Date**](scripting_objects/date): This object is provided to make it easier to deal with variables representing dates. It is obtained from the **DOpusFactory.Date** method as well as various properties in other objects.
* [**Dialog**](scripting_objects/dialog): This object is used to display dialogs or popup menus. It is obtained from the **Func.Dlg**, **Command.Dlg** or **DOpus.Dlg** methods.
* [**DialogListColumn**](scripting_objects/dialoglistcolumn): The **DialogListColumn** object represents a column in a _Details_ mode _list view_ control in a [script dialog.](../../scripting/script_dialogs) It's obtained by enumerating the [**DialogListColumns**](scripting_objects/dialoglistcolumns) object.**\~control**
* [**DialogListColumns**](scripting_objects/dialoglistcolumns): The **DialogListColumns** object lets you query or modify the columns in a _Details_ mode _list view_ control in a [script dialog.](../../scripting/script_dialogs) Use the [**Control**](scripting_objects/control)**.columns** property to obtain a **DialogListColumns** object.
* [**DialogListGroup**](scripting_objects/dialoglistgroup): The **DialogListGroup** object represents a group in a _list view_ control in a [script dialog](../../scripting/script_dialogs). It's returned by the [**Control**](scripting_objects/control)**.GetGroupById** method.
* [**DialogListItem**](scripting_objects/dialoglistitem): The **DialogListItem** object represents an item in a _combo box_ or _list box_ control in a [script dialog](../../scripting/script_dialogs). It's returned by the [**Control**](scripting_objects/control)**.GetItemAt** and [**Control**](scripting_objects/control)**.GetItemByName** methods.
* [**DialogOption**](scripting_objects/dialogoption): This object is used in conjunction with the **Dialog** object. It lets you specify a checkbox option that is added to the dialog.
* [**Dock**](scripting_objects/dock): This object represents a floating toolbar. The Toolbar object provides a collection that represents all instances of that toolbar that are currently floating.
* [**DocMeta**](scripting_objects/docmeta): This object provides metadata properties relating to document files. It is obtained from the **Metadata** object.
* [**DOpusFactory**](scripting_objects/dopusfactory): This object is a helper object that you can use to create various other objects like **Map** and **Vector**. It is obtained from the **DOpus.Create** method.
* [**DPI**](scripting_objects/dpi): The **DPI** object is a helper object that provides a number of methods and properties relating to the system DPI setting. It's returned via the [**DOpus**](scripting_objects/dopus)**.DPI** property.
* [**Drive**](scripting_objects/drive): The **Drive** object provides information about a drive (hard drive, CD ROM, etc) on your system. A **Vector** of drives on your system can be obtained from the [**FSUtil**](scripting_objects/fsutil)**.Drives** method.
* [**EverythingInterface**](scripting_objects/everythinginterface): Provides an interface between Opus and Everything (by voidtools).
* [**EverythingResult**](scripting_objects/everythingresult): Represents a search result returned from an Everything query.
* [**ExeMeta**](scripting_objects/exemeta): This object provides metadata properties relating to executable (program) files. It is obtained from the **Metadata** object.
* [**Favorite**](scripting_objects/favorite): The **Favorite** object represents a [favorite folder](../../basic_concepts/the_lister/navigation/favorites). It is retrieved by enumerating or indexing the [Favorites](scripting_objects/favorites)object.
* [**Favorites**](scripting_objects/favorites): The **Favorites** object holds a collection of all the defined [favorite folders](../../basic_concepts/the_lister/navigation/favorites). It is retrieved from the [**DOpus**](scripting_objects/dopus)**.favorites** method.
* [**File**](scripting_objects/file): This object lets you read or write binary data from or to a file. It is obtained from the **FSUtil.OpenFile** and **Item.Open** methods.
* [**FileAttr**](scripting_objects/fileattr): This object represents file attributes (like read only, archived, etc). It used by the **Item** and **Format** objects, and can be created by the [**FSUtil**](scripting_objects/fsutil)**.NewFileAttr** method.
* [**FileGroup**](scripting_objects/filegroup): This object exposes information about a file group (when a **Tab** is set to group by a particular column). It is used by the **Item** and **Tab** objects.
* [**FileSize**](scripting_objects/filesize): This object is used to represent a size in bytes (mainly because ActiveX scripting doesn't have proper support for 64 bit integers). It is used by the **Item** and **TabStats** objects.
* [**FiletypeGroup**](scripting_objects/filetypegroup): This object represents a file type group (as configured in the [File Type Groups](../../file_types/file_type_groups) section of the [file type editor](../../file_types)).
* [**FiletypeGroups**](scripting_objects/filetypegroups): This object represents a collection of one or more file type groups.
* [**Filter**](scripting_objects/filter): Lets you create a complex filter that can be used with commands like **Copy** when run from a script.
* [**FilterParseError**](scripting_objects/filterparseerror): Used to access information about a parsing error when working with **Filter** objects.
* [**FolderEnum**](scripting_objects/folderenum): This object lets a script enumerate the contents of a folder. It is obtained using the **FSUtil.ReadDir** method.
* [**FontMeta**](scripting_objects/fontmeta): This object provides metadata properties relating to font files. It is obtained from the **Metadata** object.
* [**Format**](scripting_objects/format): This object provides information about the display format in a tab. It is obtained from the **Tab.format** property.
* [**FSUtil**](scripting_objects/fsutil): This object provides various utility methods relating to file system activity. It is obtained from the **DOpus.FSUtil** property.
* [**Func**](scripting_objects/func): This object is passed to a [script function](../../scripting/script_functions) (via **ClickData.func**) or [script-defined internal command](../../scripting/example_scripts/adding_a_new_internal_command) (via **ScriptCommandData.func**). It provides information relating to the function invocation (source and destination tabs, arguments, etc).
* [**GlobalFilters**](scripting_objects/globalfilters): This object lets you access information about the global filter settings (configured on the [**Filters**](../../preferences/preferences_categories/filtering_and_sorting/filters) page in Preferences).
* [**HTTPRequest**](scripting_objects/httprequest): This object lets you easily send an asynchronous HTTP request and receive the results. You can create this object using the [**Dialog**](scripting_objects/dialog)**.NewHTTPReq** method.
* [**Image**](scripting_objects/image): This object represents an image file or icon loaded from disk that can be displayed in a [script dialog](../../scripting/script_dialogs).
* [**ImageMeta**](scripting_objects/imagemeta): This object provides metadata properties relating to image files. It is obtained from the **Metadata** object.
* [**IncludeFileInitData**](scripting_objects/includefileinitdata): If an [include file](../../scripting/script_add-ins/include_files) script implements the optional [**oninitincludefile**](https://github.com/Chaoses-Ib/DirectoryOpus/blob/main/Manual/reference/scripting_reference/scripting_objects/scripting_events/oninitincludefile.md) method, it receives this object to let it provide information about the include file.
* [**Item**](scripting_objects/item): This object represents a file or a folder. It can be returned from various methods of the **Tab** object, when enumerating a folder using the **FSUtil.ReadDir** method, and is used to provide files for a command to act on using the **Command** object.
* [**Items**](scripting_objects/items): The **Items** object lets you enumerate a list of one or more **Item** objects.
* [**Lister**](scripting_objects/lister): This object represents a [Lister](../../basic_concepts/the_lister) window.
* [**Listers**](scripting_objects/listers): The \*\*[Listers](scripting_objects/listers)\*\*object is a collection of all currently open Lister windows (each one represented by a \*\*[Lister](scripting_objects/lister)\*\*object). It can be obtained from the **DOpus.listers** property.
* [**Map**](scripting_objects/map): This object is similar to an array or vector (e.g. [**Vector**](scripting_objects/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. It is obtained from the **DOpusFactory.Map** method.
* [**Metadata**](scripting_objects/metadata): This object represents a file or folder's metadata. It can be obtained from the **Item.metadata** property, as well as the **FSUtil.GetMetadata** method.
* [**Msg**](scripting_objects/msg): The **Msg** object represents a [script dialog](../../scripting/script_dialogs) input event message. It’s returned by the [**Dialog**](scripting_objects/dialog)**.GetMsg** method which you call when running the message loop for a [detached dialog](../../scripting/script_dialogs/the_dialog_message_loop/detached_dialogs).
* [**OrderedMap**](scripting_objects/orderedmap): This is the same as a [**Map**](scripting_objects/map) except that the order of items added to the map is preserved rather than being sorted alphabetically. It is obtained from the **DOpusFactory.OrderedMap** method.
* [**OtherMeta**](scripting_objects/othermeta): This object provides general metadata properties relating to files and folders. It is obtained from the **Metadata** object.
* [**PairedFolder**](scripting_objects/pairedfolder): This object represents a [paired folder](../../preferences/preferences_categories/frequently_used_paths/paired_folders) retrieved from the **FSUtil.GetFolderPair** method.
* [**Path**](scripting_objects/path): This object represents a file system path. It contains several methods to manipulate the path. Path objects are returned by several properties and can be created by the **FSUtil.NewPath** method.
* [**Progress**](scripting_objects/progress): This object represents a progress dialog, that lets you visually indicate to the user the progress of your script function. It is obtained from the **Command.progress** property.
* [**QuickFilter**](scripting_objects/quickfilter): This object provides information about the state of the quick filter in a tab. It's obtained from the [**Tab**](scripting_objects/tab)**.quickfilter** property.
* [**Rect**](scripting_objects/rect): The **Rect** object represents a rectangle.
* [**Results**](scripting_objects/results): This object represents the results of a command (the error code in the case of failure, plus any new tabs or Listers created by the command). It is obtained from the **Command.results** property.
* [**ScriptColorPair**](scripting_objects/scriptcolorpair): This object bundles a pair of colors (text / background) together.
* [**ScriptColumn**](scripting_objects/scriptcolumn): This object represents a [script-defined column](../../scripting/example_scripts/adding_a_new_column). It is obtained from the **ScriptInitData.AddColumn** method, while processing the **OnInit** event.
* [**ScriptCommand**](scripting_objects/scriptcommand): This object represents a [script-defined internal command](../../scripting/example_scripts/adding_a_new_internal_command). It is obtained from the **ScriptInitData.AddCommand** method, while processing the **OnInit** event.
* [**ScriptFAYTCommand**](scripting_objects/scriptfaytcommand): This object is provided as a property of the **ScriptCommand** object for script add-ins that [extend the FAYT field](../../scripting/example_scripts/extending_the_fayt).
* [**ScriptConfig**](scripting_objects/scriptconfig): This object represents script-defined configuration data that Opus stores for each script. The configuration items are initialised via the **ScriptInitData.config** property, and are then available to the script via the **Script.config** property.
* [**ScriptStrings**](scripting_objects/scriptstrings): The **ScriptStrings** object is returned by the [**DOpus**](scripting_objects/dopus)**.strings** property. It lets you access any strings defined via [string resources](../../scripting/resources/string_resources).
* [**ShellProperty**](scripting_objects/shellproperty): The **ShellProperty** object represents a shell property - an item of metadata for a file or folder that comes from Windows or third-party extensions. The [**FSUtil**](scripting_objects/fsutil)**.GetShellPropertyList** method lets you retrieve a list of available shell properties.
* [**Signature**](scripting_objects/signature): The **Signature** object is returned by the [**FSUtil**](scripting_objects/fsutil)**.GetSignature** method to provide information about the signature used to digitally sign an executable file.
* [**SmartFavorite**](scripting_objects/smartfavorite): A **SmartFavorite** object represents an entry for a folder in the [SmartFavorites](../../basic_concepts/the_lister/navigation/smartfavorites) table. It is retrieved by enumerating or indexing the [**SmartFavorites**](scripting_objects/smartfavorites) object.
* [**SmartFavorites**](scripting_objects/smartfavorites): The **SmartFavorites** object lets you query the contents of the [SmartFavorites](../../basic_concepts/the_lister/navigation/smartfavorites) table. It is retrieved from the [**DOpus**](scripting_objects/dopus)**.smartfavorites** property.
* [**SortOrder**](scripting_objects/sortorder): The **SortOrder** object is returned by the [**Format**](scripting_objects/format)**.manual\_sort\_order** property if [manual sort mode](../../basic_concepts/sorting_and_grouping/manual_sorting) is active. It lets you query and modify the sort order.
* [**StringTools**](scripting_objects/stringtools): This object provides utility functions for string encoding and decoding. It is obtained from the **DOpusFactory.StringTools** method.
* [**StringSet**](scripting_objects/stringset): This object is similar to an array or vector (e.g. [**Vector**](scripting_objects/vector)) of strings, but has the advantage of using a dictionary system to locate strings rather than numeric indexes. It is obtained from the **DOpusFactory.StringSet** and **StringSetI** methods.
* [**SysInfo**](scripting_objects/sysinfo): 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.
* [**Tab**](scripting_objects/tab): This object represents a folder tab in a Lister. A Lister's tabs are available via various Lister object properties (e.g. **Lister.activetab**) and also used to specify the source/destination of a command (e.g. **Command.sourcetab**).
* [**TabGroup**](scripting_objects/tabgroup): This object represents a [folder tab group](../../basic_concepts/the_lister/tabs/tab_groups). It's accessed by enumerating the \*\*[TabGroups](scripting_objects/tabgroups)\*\*object.
* [**TabGroups**](scripting_objects/tabgroups): This object provides access to and lets you modify the configured list of [folder tab groups](../../basic_concepts/the_lister/tabs/tab_groups). It's obtained from the [**DOpus**](scripting_objects/dopus)**.tabgroups** property.
* [**TabGroupTabEntry**](scripting_objects/tabgrouptabentry): This object represents a folder tab in a [tab group.](../../basic_concepts/the_lister/tabs/tab_groups)
* [**TabGroupTabList**](scripting_objects/tabgrouptablist): This object represents a list of folder tabs in a [tab group](../../basic_concepts/the_lister/tabs/tab_groups).
* [**TabStats**](scripting_objects/tabstats): This object provides various statistics about a folder tab (the number of selected files, total number of items, etc). It is obtained from the **Tab.stats** and **Tab.selstats** properties.
* [**Toolbar**](scripting_objects/toolbar): This object represents a toolbar. It is obtained with the **DOpus.toolbars** and **Lister.toolbars** properties.
* [**Toolbars**](scripting_objects/toolbars): The **Toolbars** object lets you enumerate all the defined toolbars in your Directory Opus configuration (whether currently turned on or not).
* [**UnorderedSet**](scripting_objects/unorderedset): Similar to a \*\*[StringSet](scripting_objects/stringset)\*\*but can store elements of any type rather than just strings.
* [**Var**](scripting_objects/var): This object represents a variable. Toolbar buttons, hotkeys and scripts can read and store variables, and variables can be saved from one session of Opus to another. The **Var** object is obtained from the **Vars** collection.
* [**Vars**](scripting_objects/vars): This object represents a collection of variables. Depending on the variables' scope it can be obtained from the **DOpus.vars**, **Lister.vars**, **Tab.vars**, **Command.vars** or **Script.vars** properties.
* [**Vector**](scripting_objects/vector): This object is similar to an array - it can store an unlimited number of elements of any type. Several properties and methods in the Opus scripting interface use Vectors, and you can use them interchangeably with arrays in most cases. The Vector is provided because some scripting languages only offer incomplete or incompatible arrays - using Vectors means the object can be used consistently across any ActiveX scripting language. A **Vector** is created by the **DOpusFactory.Vector** method.
* [**Version**](scripting_objects/version): This object represents information about the current Opus version. It is obtained from the **DOpus.Version** property.
* [**VideoMeta**](scripting_objects/videometa): This object provides metadata properties relating to movie files. It is obtained from the **Metadata** object.
* [**Viewer**](scripting_objects/viewer): The **Viewer** object represents a standalone [image viewer](../../additional_functionality/viewing_images).
* [**Viewers**](scripting_objects/viewers): The **Viewers** object is a collection of all currently open standalone [image viewers](../../additional_functionality/viewing_images). It can be obtained via the [**DOpus**](scripting_objects/dopus)**.viewers** property
* [**Wild**](scripting_objects/wild): This object allows a script to access the in-built pattern matching functions in Opus. It is obtained from the **FSUtil.NewWild** method.
* [**WinVer**](scripting_objects/winver): This object represents information about the current Windows version. It is obtained from the **Version.winver** property.
