Tab

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 Results object.

Property Name	Return Type	Description
all	collection:Item	Returns a collection of Item objects that represents all the files and folders currently displayed in this tab. Note: The first time a script accesses this property (and all the other properties that return an Item collection), a snapshot is taken of all the appropriate items. If the script then makes changes to those items (e.g. by creating a new file, modifying the selection, etc), these changes will not be reflected by the collection. To re-synchronize the collection call the Update method on the collection.
crumbpath	object:Path	Returns the current path from the tab's breadcrumb control (if it has one), including any ghost path.
dirs	collection:Item	Returns a collection of Item objects that represents all the folders currently displayed in this tab.
files	collection:Item	Returns a collection of Item objects that represents all the files currently displayed in this tab.
format	object:Format	Returns a Format object representing the current folder format in this tab.
label	string	Returns the current label of the tab.
linktab	object:Tab	If this tab is linked to another tab, returns a Tab object representing the linked tab. If this tab is not linked this property returns 0.
lister	object:Lister	Returns a Lister object representing the parent Lister that owns this tab.
lock	string	Returns the current lock state of the tab; one of "off", "on", "changes", "reuse".
path	object:Path	Returns the current path shown in this tab.
right	bool	Returns True if this tab is currently on the right or bottom side of a dual-display Lister, and False otherwise.
selected	collection:Item	Returns a collection of Item objects that represents all the selected files and folders currently displayed in this tab. Note that if checkbox mode is turned on in the tab, this will be a collection of checked items rather than selected.
selected_dirs	collection:Item	Returns a collection of Item objects that represents all the selected folders currently displayed in this tab.
selected_files	collection:Item	Returns a collection of Item objects that represents all the selected files currently displayed in this tab
selstats	object:TabStats	Returns a TabStats object that provides various information about the tab, including the number of files, number of selected files, total size of selected files, etc. The "selected" counts provided by this object take checkbox mode into account (that is, if checkbox mode is currently turned on, the counts will be for checked files rather than for selected files).
slavetab	bool	Returns True if this tab is linked as a slave. This property does not exist if the tab is not linked, so make sure you check the value of linktab first.
source	bool	Returns True if this tab is currently the source, and False otherwise.
stats	object:TabStats	Returns a TabStats object that provides various information about the tab, including the number of files, number of selected files, total size of selected files, etc. Unlike selstats, this object does not take checkbox mode into account (so the "selected" counts will refer to selected rather than checked files).
vars	object:Vars	This Vars object represents all defined variables with tab scope (that are scoped to this tab).
visible	bool	Returns True if this tab is currently visible (i.e. it is the active tab in either file display), and False otherwise.

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 tab.
Update	none	none	The first time a script accesses a particular Tab object, a snapshot is taken of the tab state. If the script then makes changes to that tab (e.g. it selects files, creates a new folder, etc), these changes will not be reflected by the object. To re-synchronize the object with the tab, call the Tab.Update method.