Directory Opus

https://docs.dopus.com/doku.php?id=
Admin
Directory Opus is a highly configurable and efficient Windows file manager designed to streamline...
Tokens:421,437
Snippets:6,355
Trust Score:8.3
Update:2 months ago
Show doc for...
Tokens:
Raw
### Show PLUGINABOUT example

Source: https://docs.dopus.com/doku.php?id=reference%3Acommand_reference%3Ainternal_commands%3Ashow

Example of displaying the About dialog for a plugin.

```text
Show PLUGINABOUT text.dll
```

--------------------------------

### Install Scripts

Source: https://docs.dopus.com/doku.php?id=reference%3Acommand_reference%3Ainternal_commands%3Aprefs

Launches the Script Installer for selected or specified files.

```text
Prefs SCRIPTINSTALL
```

```text
Prefs SCRIPTINSTALL /downloads/CoolScript.osp
```

--------------------------------

### Show PLUGINCONFIG example

Source: https://docs.dopus.com/doku.php?id=reference%3Acommand_reference%3Ainternal_commands%3Ashow

Example of displaying the configuration dialog for a plugin.

```text
Show PLUGINCONFIG dcrawrap.dll
```

--------------------------------

### Show PLUGIN example

Source: https://docs.dopus.com/doku.php?id=reference%3Acommand_reference%3Ainternal_commands%3Ashow

Example of forcing a specific plugin for file display.

```text
Show PLUGIN "Animated GIF"
```

--------------------------------

### Show LOADALLTHUMBS example

Source: https://docs.dopus.com/doku.php?id=reference%3Acommand_reference%3Ainternal_commands%3Ashow

Example of triggering thumbnail generation for all files in a folder.

```text
Show LOADALLTHUMBS
```

--------------------------------

### Show LISTERLINK examples

Source: https://docs.dopus.com/doku.php?id=reference%3Acommand_reference%3Ainternal_commands%3Ashow

Examples of linking viewers to listers.

```text
Show LISTERLINK
```

```text
Show LISTERLINK=close
```

```text
Show LISTERLINK=toggle
```

--------------------------------

### Show LISTSIBLINGS example

Source: https://docs.dopus.com/doku.php?id=reference%3Acommand_reference%3Ainternal_commands%3Ashow

Example of using LISTSIBLINGS to populate the viewer's next/previous list.

```text
Show FULLSCREEN LISTSIBLINGS
```

--------------------------------

### UnorderedSet Output Example

Source: https://docs.dopus.com/doku.php?id=reference%3Ascripting_reference%3Ascripting_objects%3Aunorderedset

The expected console output from the provided JScript example.

```text
count: 5
Item: cat
Item: dog
Item: D:\
Item: C:\
Item: C:\
```

--------------------------------

### Show PLUGINDISABLE examples

Source: https://docs.dopus.com/doku.php?id=reference%3Acommand_reference%3Ainternal_commands%3Ashow

Examples of enabling, disabling, or toggling plugin states.

```text
Show PLUGINDISABLE PLUGIN gifanim.dll
```

```text
Show PLUGINDISABLE=enable PLUGIN text.dll
```

```text
Show PLUGIN audiotags.dll PLUGINDISABLE disable
```

```text
Show PLUGIN="audiotags.dll" PLUGINDISABLE=toggle
```

```text
@toggle:invert
Show PLUGIN="wma.dll" PLUGINDISABLE=toggleCopy
```

--------------------------------

### Show HEADING examples

Source: https://docs.dopus.com/doku.php?id=reference%3Acommand_reference%3Ainternal_commands%3Ashow

Examples of using the HEADING argument to add a heading to dynamic lists.

```text
Show THUMBNAILSIZE=list HEADING
```

```text
Show THUMBNAILSIZE=list HEADING="Thumb Size"
```

--------------------------------

### Add Columns

Source: https://docs.dopus.com/doku.php?id=reference%3Acommand_reference%3Ainternal_commands%3Aset

Examples of adding columns with various position and size parameters.

```text
Set COLUMNSADD picwidth
```

```text
Set COLUMNSADD desc(2),author(*,*)
```

```text
Set COLUMNSADD picwidth(*,a)
```

```text
Set COLUMNSADD=Status(!1+Name)
```

--------------------------------

### Set FRIENDLYDATES command examples

Source: https://docs.dopus.com/doku.php?id=reference%3Acommand_reference%3Ainternal_commands%3Aset

Configures how dates are displayed in file lists.

```text
Set FRIENDLYDATES=normal
```

```text
Set FRIENDLYDATES=today
```

```text
Set FRIENDLYDATES=off
```

```text
Set FRIENDLYDATES=toggle
```

```text
Set FRIENDLYDATES=toggle,normal
```

--------------------------------

### Resolve path examples

Source: https://docs.dopus.com/doku.php?id=reference%3Aevaluator%3Aresolve

Demonstrates resolving an alias to a full path and a full path to an alias using the 'a' flag.

```text
Output(Resolve("/onedrive"));
--> C:\Users\jon\OneDrive
Output(Resolve("c:\Users\jon\OneDrive", "a"));
--> /onedriveCopy
```

--------------------------------

### Set FULLROWSELECT command examples

Source: https://docs.dopus.com/doku.php?id=reference%3Acommand_reference%3Ainternal_commands%3Aset

Configures full-row selection behavior in file displays.

```text
Set FULLROWSELECT=on
```

```text
Set FULLROWSELECT=off
```

```text
Set FULLROWSELECT=toggle
```

```text
Set FULLROWSELECT=toggle,power
```

```text
Set FULLROWSELECT=on,details
```

```text
Set FULLROWSELECT=toggle,display
```

```text
Set FULLROWSELECT=off,namecol
```

--------------------------------

### Copy CREATEFOLDER and READAUTO command examples

Source: https://docs.dopus.com/doku.php?id=reference%3Acommand_reference%3Ainternal_commands%3Acopy

Creates a new folder and controls how it is displayed in the file lister.

```text
Copy CREATEFOLDER "Backup-{date|yyyyMMdd}" READAUTO
```

```text
Copy CREATEFOLDER "Backup-{date|yyyyMMdd}" READAUTO=no
```

```text
Copy CREATEFOLDER "Backup-{date|yyyyMMdd}" READAUTO=dual
```

```text
Copy CREATEFOLDER "Backup-{date|yyyyMMdd}" READAUTO=left,tab
```

```text
Copy CREATEFOLDER "Backup-{date|yyyyMMdd}" READAUTO=right
```

```text
Copy CREATEFOLDER "Backup-{date|yyyyMMdd}" READAUTO=dual,tab
```

```text
Copy CREATEFOLDER "Backup-{date|yyyyMMdd}" READAUTO=tab,nofocus
```

--------------------------------

### Example FTP Path

Source: https://docs.dopus.com/doku.php?id=ftp%3Aftp_paths

An example of a full FTP path with username, password, and host. This can be typed into the location field or used in commands.

```plaintext
ftp://jon:apple@bigcompany.com/
```

--------------------------------

### PathType usage example

Source: https://docs.dopus.com/doku.php?id=reference%3Aevaluator%3Apathtype

Demonstrates how to use PathType to identify a shell path.

```text
Output(PathType("/thispc"));
--> shell
```

--------------------------------

### Simple Wildcard Rename Example

Source: https://docs.dopus.com/doku.php?id=file_operations%3Arenaming_files%3Asimple_wildcard_rename

Example showing how the wildcard pattern transforms filenames by preserving the middle section.

```text
Img_2481.jpg    IMG2481.jpg

IMG_2483.JPG    IMG2483.jpg

Img_2486.jpg    IMG2486.jpgCopy
```

--------------------------------

### Set FORMATLOCK command examples

Source: https://docs.dopus.com/doku.php?id=reference%3Acommand_reference%3Ainternal_commands%3Aset

Configures the format lock state for file displays.

```text
Set FORMATLOCK=toggle,all
```

```text
Set FORMATLOCK=toggle,left
```

```text
Set FORMATLOCK=toggle,right
```

```text
Set FORMATLOCK=toggle,source
```

```text
Set FORMATLOCK=toggle,dest
```

```text
Set FORMATLOCK=off,all
```

--------------------------------

### Set FTPMODE command examples

Source: https://docs.dopus.com/doku.php?id=reference%3Acommand_reference%3Ainternal_commands%3Aset

Sets the transfer mode for FTP connections.

```text
Set FTPMODE=ascii
```

```text
Set FTPMODE=binary
```

```text
Set FTPMODE=auto
```

--------------------------------

### Configure and Start Synchronization in Panel

Source: https://docs.dopus.com/doku.php?id=release_history%3Aopus13_detailed%3Asynchronize

The Find SYNC RUNINPANEL command allows for configuring the synchronization panel and starting the operation with a single command.

```dopuscript
Find SYNC RUNINPANEL
```

--------------------------------

### Copy QUEUE command examples

Source: https://docs.dopus.com/doku.php?id=reference%3Acommand_reference%3Ainternal_commands%3Acopy

Configures automatic or manual file copy queuing behavior.

```text
Copy QUEUE
```

```text
Copy QUEUE=MyQueue
```

```text
Copy QUEUE=none
```

```text
Copy QUEUE=none,shift,MyQueue TO \\NAS1\Storage
```

```text
Copy QUEUE=MyQueue,quiet
```

```text
Copy QUEUE=MyQueue,noisy
```

--------------------------------

### Copy SENDTO command example

Source: https://docs.dopus.com/doku.php?id=reference%3Acommand_reference%3Ainternal_commands%3Acopy

Sends selected files to a specific system Send To target.

```text
Copy SENDTO "Web Publishing Wizard"
```

--------------------------------

### Full Detached Dialog Implementation

Source: https://docs.dopus.com/doku.php?id=scripting%3Ascript_dialogs%3Athe_dialog_message_loop%3Adetached_dialogs

A complete example showing dialog initialization, detachment, and event processing.

```VBScript
Function OnClick(ByRef clickData)
  Set Dlg = DOpus.Dlg
  Dlg.window = clickData.func.sourcetab
  Dlg.template = "testdlg"
  Dlg.detach = True
  Dlg.Show
  Do
    Set Msg = Dlg.GetMsg
    If Not Msg.result Then Exit Do
    DOpus.Output "Msg Event = " & Msg.event
  Loop
  DOpus.Output "Return code = " & Dlg.result
End Function
```

```JScript
function OnClick(clickData) {
  var Dlg = DOpus.Dlg;
  Dlg.window = clickData.func.sourcetab;
  Dlg.template = "testdlg";
  Dlg.detach = true;
  Dlg.Show();
  while (true) {
    var Msg = Dlg.GetMsg();
    if (!Msg.result) break;
    DOpus.Output("Msg Event = " + Msg.event);
  }
  DOpus.Output("Return code = " + Dlg.result);
}
```

--------------------------------

### OnStartup Event

Source: https://docs.dopus.com/doku.php?id=reference%3Ascripting_reference%3Ascripting_events%3Aonstartup

This event is triggered only when Opus starts up. It is intended for script add-ins that are already installed. If a script is installed while Opus is running, it will not receive the OnStartup event until the next time Opus is launched.

```APIDOC
## OnStartup

### Description
The **OnStartup** event can be implemented by a script add-in to receive notification when Opus starts up.

### Method Name
OnStartup

### Argument Type
StartupData

### Return Type
_none_

### Description
This event is only triggered when Opus starts up, therefore only script add-ins that are already installed will receive it. If a script is installed when Opus is already running it won't receive **OnStartup** until the next time Opus is started.
```

--------------------------------

### Run Application Action Command

Source: https://docs.dopus.com/doku.php?id=file_types%3Afiletype_editor%3Aactions

Example command line configuration for the open action of .jpg files using rundll32.

```text
C:\Windows\System32\rundll32.exe "C:\Program Files\Windows Photo Viewer\PhotoViewer.dll", ImageView_Fullscreen %1
```

--------------------------------

### Initiate Backup and Restore Wizard

Source: https://docs.dopus.com/doku.php?id=reference%3Acommand_reference%3Ainternal_commands%3Aprefs

Opens the interactive Backup and Restore Configuration wizard.

```text
Prefs BACKUPRESTORE
```

```text
Prefs BACKUPRESTORE TO="/desktop\Backup for %username% on {date|yyyy-MM-dd}" PASSWORD="cat" DESC="Quick Backup."
```

--------------------------------

### Count files using FileCount

Source: https://docs.dopus.com/doku.php?id=reference%3Aevaluator%3Afilecount

Examples demonstrating how to count files matching a pattern and how to restrict the count to selected items.

```javascript
if (FileCount("*.jpg") > 2) { ... } // at least three jpgs in folder 
if (FileCount(true, "dirs:new*") == 5) { ... } // 5 folders starting with new are selected
```

--------------------------------

### Mid(string, start, [length])

Source: https://docs.dopus.com/doku.php?id=reference%3Aevaluator%3Amid

Returns a portion of a string starting from a specific index.

```APIDOC
## Mid(string, start, [length])

### Description
Returns a specified number of characters from a string starting at a given position. If the length parameter is omitted or set to -1, the function returns the remainder of the string from the start position.

### Parameters
- **string** (string) - The input string to process.
- **start** (int) - The zero-based starting position for the extraction.
- **length** (int) - Optional. The number of characters to return.

### Return Value
- **string** - The extracted portion of the input string.

### Example
```
Output( Mid("Hello To You", 6, 2) );
--> To
```
```

--------------------------------

### Init

Source: https://docs.dopus.com/doku.php?id=reference%3Ascripting_reference%3Ascripting_objects%3Aprogress

Initializes the progress dialog.

```APIDOC
## Init(parent, title)

### Description
Creates the progress dialog. Must be called before Show().

### Parameters
- **parent** (Tab/Lister) - Required - The window to center the dialog over.
- **title** (string) - Optional - The window title of the dialog.
```

--------------------------------

### Launch External Program with Arguments

Source: https://docs.dopus.com/doku.php?id=customize%3Acreating_your_own_buttons%3Acommand_editor%3Asimple_command_editor

This example shows how to launch an external program, Notepad, and pass it the name of the first selected file in the file display. External control codes are used for this purpose.

```opus-command
"C:\\Windows\\notepad.exe" {file:1}
```

--------------------------------

### Create a new collection

Source: https://docs.dopus.com/doku.php?id=reference%3Adopusrt_reference%3Aexternal_manipulation_of_file_collections

Initializes a new collection with optional flags for descriptions, icons, or duplicate file modes.

```cmd
dopusrt.exe /col create "/desc:My Photos" Photos
```

--------------------------------

### Filter Clause Example

Source: https://docs.dopus.com/doku.php?id=reference%3Ascripting_reference%3Ascripting_objects%3Afilter

An example of a fully formed textual filter clause used with the Add method.

```text
size match > 2 mb
```

--------------------------------

### Show()

Source: https://docs.dopus.com/doku.php?id=reference%3Ascripting_reference%3Ascripting_objects%3Adialog

Displays the pre-configured dialog.

```APIDOC
## Show()

### Description
Displays the dialog that has been pre-configured. If detach is False, the call blocks until the dialog is closed.

### Returns
- **int** - The index of the button selected by the user.
```

--------------------------------

### Get List of Items in a Tab with DOpusRT

Source: https://docs.dopus.com/doku.php?id=reference%3Adopusrt_reference%3Aretrieving_file_and_folder_information

Use the 'list' command to get all items displayed in a specific tab. Specify '0' or omit the tab argument to use the active tab. The output is saved to an XML file.

```bash
dopusrt.exe /info %temp%\filelist.txt,list
```

--------------------------------

### Configure Drive Buttons with Multiple Parameters

Source: https://docs.dopus.com/doku.php?id=customize%3Acreating_your_own_buttons%3Aediting_the_toolbar%3Adynamic_buttons%3Adrive_buttons_configuration

Example showing how to display only removable and CD/DVD drives while excluding drive P.

```text
Go DRIVEBUTTONS=removable,cdrom,-P
```

--------------------------------

### Run Notepad with Selected File

Source: https://docs.dopus.com/doku.php?id=customize%3Acreating_your_own_buttons%3Asynchronous_and_asynchronous_functions

This example demonstrates how a command to run Notepad with a selected file behaves differently based on whether it's executed synchronously or asynchronously, especially when multiple files are selected.

```batch
notepad.exe {f}
```

--------------------------------

### Launch Directory Opus non-elevated

Source: https://docs.dopus.com/doku.php?id=reference%3Adopusrt_reference

Starts the application as a non-elevated process.

```cmd
dopusrt.exe /runopus
```

--------------------------------

### Set GLOBALHIDEFILTER command examples

Source: https://docs.dopus.com/doku.php?id=reference%3Acommand_reference%3Ainternal_commands%3Aset

Enables or disables global wildcard filters.

```text
Set GLOBALHIDEFILTER on
```

```text
Set GLOBALHIDEFILTER off
```

--------------------------------

### Variable Conversion and Formatting Examples

Source: https://docs.dopus.com/doku.php?id=reference%3Aevaluator%3Aas

Demonstrates converting a string to a date, formatting a double with decimal limits, and formatting a large integer as a file size.

```text
d = "2023-09-23" as date;
Output(d as "D#dd-MMM-yyyy");
--> 23-Sep-2023

i = 1 as double / 3;
Output(i as "%-.3");
--> 0.333

i = 183743933;
output(i as "%.3kb");
--> 179,437.435 KB
```

--------------------------------

### Multi-line command syntax

Source: https://docs.dopus.com/doku.php?id=customize%3Acreating_your_own_buttons%3Acommand_editor%3Aadvanced_command_editor

Demonstrates how to split a complex command across multiple lines using the [[ prefix.

```text
Find IN C:\
[[QUERY *.jpg]]
[[
FILTERDEF
size match > 100 kb
and size match < 200 kb
]]Copy
```

--------------------------------

### Copy SENDMAIL command examples

Source: https://docs.dopus.com/doku.php?id=reference%3Acommand_reference%3Ainternal_commands%3Acopy

Sends selected files as email attachments.

```text
Copy SENDMAIL
```

```text
Copy SENDMAIL=f.bloggs@company.com
```

--------------------------------

### Find with RUNINPANEL

Source: https://docs.dopus.com/doku.php?id=reference%3Acommand_reference%3Ainternal_commands%3Afind

Opens the Duplicate Finder panel and automatically starts the operation.

```text
Find IN C:\Data DUPES RUNINPANEL
```

--------------------------------

### Set GLOBALHIDEFILENAME command examples

Source: https://docs.dopus.com/doku.php?id=reference%3Acommand_reference%3Ainternal_commands%3Aset

Manages the global hide filter filename patterns.

```text
Set GLOBALHIDEFILENAME
```

```text
Set GLOBALHIDEFILENAME "(desktop.ini|*.db)"
```

```text
Set GLOBALHIDEFILENAME regex:.db$
```

--------------------------------

### Extracting a substring with Mid

Source: https://docs.dopus.com/doku.php?id=reference%3Aevaluator%3Amid

Returns a portion of the input string starting at the specified index.

```text
Output( Mid("Hello To You", 6, 2) );
--> ToCopy
```

--------------------------------

### Create and Enumerate a Map

Source: https://docs.dopus.com/doku.php?id=reference%3Ascripting_reference%3Ascripting_objects%3Amap

Demonstrates creating a Map, populating it with key-value pairs, and iterating through the contents.

```JScript
var map = DOpus.Create.Map();

map("cat") = "meow";
map("dog") = "woof";
map("bird") = "tweet";
map("snake") = "hiss";

DOpus.Output("count: " + map.count);

for (var e = new Enumerator(map); !e.atEnd(); e.moveNext())
{
 var key = e.item();
 var value = map(key);
 DOpus.Output(key + " -> " + value);
}
```

```VBScript
Dim map, key, value
Set map = DOpus.Create.Map

map("cat") = "meow"
map("dog") = "woof"
map("bird") = "tweet"
map("snake") = "hiss"

DOpus.Output "count: " & map.count

For Each key In map
 value = map(key)
 DOpus.Output(key & " -> " & value)
Next
```

--------------------------------

### Execute User Command with Arguments

Source: https://docs.dopus.com/doku.php?id=customize%3Athe_customize_dialog%3Auser_commands

Example of calling a user-defined command with a specific argument and the resulting internal command execution.

```text
Command line:| Select_Files_Of_Type txt  
---|---  
Runs:| Select *.txt
```

--------------------------------

### Dialog Resource XML Template

Source: https://docs.dopus.com/doku.php?id=scripting%3Ascript_dialogs%3Athe_dialog_message_loop%3Asimple_dialogs

The XML definition for the dialog template referenced in the script examples.

```XML
<resources>
  <resource name="testdlg" type="dialog">
    <dialog fontsize="8" height="58" lang="" title="Test!" width="180">
      <control halign="left" height="8" name="static1" title="Test Dialog"
               type="static" width="35" x="72" y="9" />
      <control close="1" default="yes" height="14" name="button1" title="One"
               type="button" width="50" x="9" y="30" />
      <control close="2" height="14" name="button2" title="Two"
               type="button" width="50" x="66" y="30" />
      <control close="3" height="14" name="button3" title="Three"
               type="button" width="50" x="122" y="30" />
    </dialog>
  </resource>
</resources>
```

--------------------------------

### IsUpper Usage Examples

Source: https://docs.dopus.com/doku.php?id=reference%3Aevaluator%3Aisupper

Demonstrates checking strings for uppercase content using the IsUpper function.

```text
Output(IsUpper("ABCDE"))
--> true

Output(IsUpper("ABcDE"))
--> false
```

--------------------------------

### Define DPI-aware icon sets in XML

Source: https://docs.dopus.com/doku.php?id=reference%3Aicon_sets%3Adpi_aware_icon_sets

Example configuration showing how to map different icon image files to specific DPI scale factors within an icon set definition.

```xml
<set filename="DEFAULT_ICONS_22.PNG" size="small" width="22" height="22">
    <dpi base="100">
        <scale factor="100" filename="DEFAULT_ICONS_22.PNG" width="22" height="22" no_scale_min="0" no_scale_max="125" />
        <scale factor="150" filename="DEFAULT_ICONS_32.PNG" width="32" height="32" no_scale_min="126" no_scale_max="175" />
        <scale factor="200" filename="DEFAULT_ICONS_48.PNG" width="48" height="48" />
        <scale factor="300" filename="DEFAULT_ICONS_64.PNG" width="64" height="64" />
    </dpi>
    <icon col="1" name="empty" row="1" />
    <icon col="2" name="spacer" row="1" />
    ...
</set>
<set filename="DEFAULT_ICONS_32.PNG" size="large" width="32" height="32">
    <dpi base="100">
        <scale factor="100" filename="DEFAULT_ICONS_32.PNG" width="32" height="32" no_scale_min="0" no_scale_max="125" />
        <scale factor="150" filename="DEFAULT_ICONS_48.PNG" width="48" height="48" no_scale_min="126" no_scale_max="175" />
        <scale factor="200" filename="DEFAULT_ICONS_64.PNG" width="64" height="64" />
    </dpi>
    <icon col="1" name="empty" row="1" />
    <icon col="2" name="spacer" row="1" />
    ...
</set>
```

--------------------------------

### Configure Drive Buttons for Non-Empty Removable Drives

Source: https://docs.dopus.com/doku.php?id=customize%3Acreating_your_own_buttons%3Aediting_the_toolbar%3Adynamic_buttons%3Adrive_buttons_configuration

Example showing how to display only removable drives that contain media.

```text
Go DRIVEBUTTONS=hideempty,removable
```

--------------------------------

### IsSpace Usage Examples

Source: https://docs.dopus.com/doku.php?id=reference%3Aevaluator%3Aisspace

Demonstrates checking strings for whitespace content using the IsSpace function.

```text
Output(IsSpace("     "))
--> true

Output(IsSpace("_____"))
--> false
```
Tokens:
Raw