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.
Property Name |
Return Type |
Description |
---|---|---|
activetab |
object:Tab |
Returns a Tab object representing the currently active (source) tab. |
bottom |
int |
Lister window bottom-edge coordinate. |
custom_title |
string |
Returns the custom title of the Lister (if any) as set by the Set LISTERTITLE command. This may be an empty string. The title property returns the actual window title. |
desttab |
object:Tab |
Returns a Tab object representing the current destination tab (in a dual-display Lister). |
dual |
int |
Indicates whether the Lister is in dual-display mode or not. Possible values
are: |
dualsize |
int |
Returns the current split percentage of the dual displays (e.g. 50 indicates they are evenly sized). |
foreground |
bool |
Returns True if this Lister is currently the foreground (active) window. |
lastactive |
bool |
Returns True if this Lister is currently the active Lister (foreground window), or was the most recently active Lister. |
layout |
string |
Provides the name of the Lister layout that this Lister came from (if any). |
left |
int |
Lister window left-edge coordinate. |
metapane |
int |
Indicates whether the metadata pane is currently open or not.
Possible values are: |
right |
int |
Lister window right-edge coordinate. |
tabs |
collection:Tab |
Returns a collection of Tab objects that represent all tabs in this Lister. In a dual-display Lister this includes tabs in both the left and right file displays. |
tabsleft |
collection:Tab |
Returns a collection of Tab objects that represent the tabs in the left/top side of a dual-display Lister. In a single-display Lister this is equivalent to all the tabs in the Lister. |
tabsright |
collection:Tab |
Returns a collection of Tab objects that represent the tabs in the right/bottom side of a dual-display Lister. In a single-display Lister this will return an empty collection. |
title |
string |
Returns the current title of the Lister window. |
toolbars |
collection:Toolbar |
Returns a collection of Toolbar objects representing all currently open toolbars in this Lister. |
top |
int |
Lister window top-edge coordinate; |
tree |
int |
Indicates whether or not the folder tree is currently open. Possible
values are: |
utilpane |
int |
Indicates whether or not the utility panel is currently open. Possible
values are: |
vars |
object:Vars |
This Vars object represents all defined variables with Lister scope (that are scoped to this Lister). |
viewpane |
int |
Indicates whether or not the viewer pane is currently open. Possible
values are: |
Method Name |
Arguments |
Return Type |
Description |
---|---|---|---|
Dlg |
none |
object:Dialog |
Creates a new Dialog object, that lets you display dialogs and popup menus. The dialog's window property will be automatically assigned to this Lister. |
Update |
none |
none |
The first time a script accesses a particular Lister object, a snapshot is taken of the Lister state. If the script then makes changes to that Lister (e.g. it opens a new tab, or moves the window), these changes will not be reflected by the object. To re-synchronize the object with the Lister, call the Lister.Update method. |