Format

The Format object represents the current display format of a tab. It is obtained from the Tab.format property.

 

Property Name

Return Type

Description

alpha_folders

bool

Returns True if folders are always sorted alphabetically, False if otherwise.

autosize

bool

Returns True if column width auto-sizing is enabled, False if otherwise.

columns

collection:Column 

Returns a collection of Column objects that represent all the individual columns currently added to the display.

format_explain

Vector:string

Returns a Vector of strings representing the explanation of the current folder format (the same text visible when hovering the mouse over the format lock icon in the status bar).

getsizes

string

Returns a string that indicates the state of the option to automatically calculate folder sizes. The string returned will be one of default, on or off.

group_by

string

If grouping is enabled, returns the name of the column that the list is grouped by.

group_reverse

bool

Returns True if the groups are sorted in reverse order.

hide_attr

string

Returns a string indicating the file attributes that are hidden (any items with these attributes set will be hidden from the display).

hide_dirs

string

Returns the wildcard pattern of folders that are hidden from the display.

hide_ext

bool

Returns True if filename extensions are hidden, or False if they are displayed.

hide_files

string

Returns the wildcard pattern of files that are hidden from the display.

hide_folder_attr

string

Returns a string indicating the folder attributes that are hidden (any folders with these attributes set will be hidden from the display). If the separate folder attribute filter is disabled this property will return the string "off".

ignore_prefix

string

Returns the filename prefixes that are ignored when sorting the list.

locked

bool

Returns True if the folder format is locked in the tab.

mix_type

string

Returns a string indicating the current file/folder mixing type. The string returned will be one of mixed, files (files first) or dirs (folders first).

name_ext

bool

Returns True if filenames and extensions are sorted separately.

numeric_name

bool

Returns True if numeric name sorting is enabled.

reverse_sort

bool

Returns True if the over-all sort order is reversed.

show_attr

string

Returns a string indicating the file attributes that are shown (only items with these attributes set will be shown in the display).

show_dirs

string

Returns the wildcard pattern of folders that are shown (only folders matching this pattern will be shown).

show_files

string

Returns the wildcard pattern of files that are shown.

show_folder_attr

string

Returns a string indicating the folder attributes that are shown (only folders with these attributes set will be shown in the display). If the separate folder attribute filter is disabled this property will return the string "off".

sort_ext

bool

Returns True if the name column is sorted by filename extension rather than filename.

sort_field

object:Column 

Returns a Column object representing the current sort field.

view

string

Returns the current view mode as a string. The returned string will be one of large_icons, small_icons, list, details, power, thumbnails or tile.

word_sort

bool

Returns True if word sorting is enabled.

 

Method Name

Arguments

Return Type

Description

Update

none

none

The first time a script accesses a particular Format object, a snapshot is taken of the tab's format. If the script then makes changes to that tab (e.g. it changes the sort field, etc), these changes will not be reflected by the object. To re-synchronize the object with the tab, call the Format.Update method.