Plugin=FileView retrieves information about folders and files.
The plugin gathers all the folder and file names, sizes, dates and icons in the selected folder. It counts the number of files and folders and obtains the combined size. It can also search recursively through all the subfolders of the selected folder to obtain the totals for count and size.
FileView operates with a "parent / child" approach. A main "parent" FileView measure is used to obtain all the information for a selected folder, and then "child" measures are used to read individual entries from the parent using the Path= option.
FileView measures take the form:
In this example, this "parent" measure will obtain name, size, date and icon information about all files in the selected folder, then create three Index values for the first three files. The information is used in subsequent "child" FileView measures:
The values of the three child measures are now the FileName information parsed into Indexes 1 through 3 by the parent measure. These can then be used with MeasureName and other options in meters.
Another way to use the information in child measures is:
The values of the three child measures are now the FileName, FileSize and FileDate information from the first file (Index 1) of the parent measure.
In these examples, three indexes are created due to the Count=3 option on the parent measure. However, the information for all files and / or folders are obtained by the plugin, and subsequent or previous entries can be assigned to the three indexes by using !CommandMeasure statements described below. This will allow a skin to "scroll" through the files and / or folders in a dynamic way.
If it is desired that a folder be monitored for new or changed files, the Update plugin command should be used in conjunction with an OnUpdateAction statement to keep the measure current with changing disk information. Be aware that having the plugin physically access the disk has a performance cost, and care should be taken to use an approriate UpdateDivider.
If set to 1, the .. folder (representing the previous folder) will be included. Otherwise the .. folder is ignored.
ShowFolder Default: 1
If set to 0, folders are ignored.
Note: To control the .. folder, use ShowDotDot above.
ShowFile Default: 1
If set to 0, files are ignored.
ShowHidden Default: 1
If set to 0, hidden files and folders are ignored.
ShowSystem Default: 0
If set to 1, protected operating system files are included.
HideExtensions Default: 0
If set to 1, file extensions are removed when used with Type=FileName.
Semi-colon separated list of file extensions that limits the type of files to be included.
Example: If Extensions="jpg;png", only .jpg and .png files are included.
SortType Default: Name
Type of information to sort the entries by. Valid values are: Name, Size, Type, Date.
SortDateType Default: Modified
File and folder date entry to use for sorting when SortType=Date. Valid values are: Modified, Created, Accessed.
SortAscending Default: 1
If set to 1, the entries are sorted in ascending order. Otherwise a descending order is used.
WildcardSearch Default: *
Wildcards used to filter included files and/or folders. Standard * and ? characters can be used.
Child measure options
Index Default: 1
Index of the file or folder from the parent measure. This should not exceed the Count number in the parent measure. If it does, the items will wrap around. For example, if Count=8, Index=9 will be treated as Index=1.
IgnoreCount Default: 0
If set to 1, the Index will represent the actual index of the file or folder in the list. This is useful to display a particular file or folder at all times (like the .. folder).
Type Default: FolderPath
Type of information to obtain from the parent measure. Valid values are: FolderPath, FolderSize, FileCount, FolderCount, FileName, FileType, FileSize, FileDate, FilePath, and Icon.
Note: If Type=Icon, the full path of the icon file is returned. See IconPath below. This can be used with MeasureName or ImageName in an Image meter to display the icon.
DateType Default: Modified
The date entry to retrieve from the parent measure when Type=Date. Valid values are: Modified, Created, Accessed.
Path of the folder to save icons when Type=Icon. If no path is given, the icons are saved in the skin folder and are named "iconX.ico", where "X" is the index number.
IconSize Default: Medium
Size of the icon to save. Valid values are: Small (for 16x16), Medium (for 32x32), Large (for 48x48), ExtraLarge (for 256x256).
Parent measure commands
Updates the measure, reading the disk and recreating all values in the parent measure.
For example, if Count=8, and there are 25 files in the list, there is a total of 4 pages. If items 8-15 (page 2) are being displayed, the PageUp will decrease the page count by one changing the displayed items to items 0-7 (page 1).
Increases the index by 1. This is useful for mouse scroll actions.
This will change the path to the folder one higher in the folder structure. Behaves like clicking on the .. folder.
Child measure commands
If the index referenced in the child measure is currently a folder, then the parent measure's Path is updated to the new path. If it is a file, then it is opened with the default Windows associated application. In order to better simulate Windows behavior, it is recommended that this command be used with a double-click action.
This will open the file or folder that the index represents. If it is a folder, the folder is opened in Windows Explorer. If it is a file, then it is opened with the default Windows associated application. In order to better simulate Windows behavior, it is recommended that this command be used with a double-click action.