TCustomShellListView class

In unit ShellCtrls

The base class that defines a list view control to display files or directories found on the local file system.

Declaration

pascal

TCustomShellListView = class(TCustomListView)

Inheritance

Descends from it: TShellListView

Description

TCustomShellListView is a TCustomListView descendant which defines a list view control for file system objects on the local file system. TCustomShellListView extends the ancestor class with properties, methods, and events needed to access and maintain the items displayed on the list view control.

Use ViewStyle to control the layout used on the list view control. The default setting is vsReport.

Use ObjectTypes to specify which file system entries are visible on the control. The default setting [otNonFolders] causes only files to be displayed. [otFolders, otNonFolders, otHidden] causes all directories and files to be displayed (including hidden files or folders).

Use Columns to specify which file system information is displayed on the list view control. By default, columns are created for file or directory name, file size, and file type information. Additional columns can be added to display attributes or permissions for the file system objects, or their last modification date/time stamp. A custom column type is available where the column content is provided by the OnGetCellText event handler in the control.

Use Root to specify the initial directory displayed on the list view control. Or, use the ShellTreeView property to associate a tree view control which can be used to navigate the directory structure on the file system and to provide the current directory visible on the list view control.

Use Mask to specify which files or folders are displayed on the control. Use MaskCaseSensitivity to control whether the file masks case sensitive.

Use Items to access the list of TFileItem instances displayed on the control.

Use the event handlers like OnAddItem and OnFileAdded to examine or validate file system objects before and after they are added to the Items collection.

Use FileSortType, SortType, and SortColumn to control sorting of the visible objects on the control. Use OnSortCompare to implement a user-specified sort order.

Use Selected, LastSelected, and MultiSelect to access the selected items on the control. Use RowSelect to control whether the entire row is selected or only the affected cell is selected on the control.

Applications should not create instance of TCustomShellListView; use the TShellListView descendant which sets the scope for members in the class. See TListView for more information about methods, properties, and events introduced in the ancestor class.

Properties

`AutoSizeColumns`	public	Indicates if columns in the control are automatically resized to fill the client display area.
`Mask`	public	File mask used to select items displayed in the shell control.
`MaskCaseSensitivity`	public	Case Sensitivity option enabled for file masks in the shell control.
`ObjectTypes`	public	Controls which file system objects are visible on the list view control.
`FileSortType`	public	Controls the sort order for object types displayed on the control.
`Root`	public	Indicates the initial directory path whose objects are displayed in the control.
`ShellTreeView`	public	Used to connect the ShellListView to a ShellTreeView.
`UseBuiltInIcons`	public	Indicates if icons provided by the OS or platform are used for items in the list.
`Items`	public	Provides access to the list of items visible on the list view control.

Methods

`WSRegisterClass`	protected	Registers an association between the class type and its widgetset class.
`CreateHandle`	protected	Creates the handle for the control and populates the Items property.
`CreateListColumns`	protected	Creates the collection used in the Columns property in the shell control.
`CreateListItem`	protected	Create a new entry added to the Items for the shell control.
`PopulateWithRoot`	protected	Fills the list view with file system information for the directory in Root.
`DoOnResize`	protected	Adjusts column widths when the control is resized.
`GetCellText`	protected
`InitColumns`	protected
`Loaded`	protected	Performs actions when LCL component streaming is completed for the component.
`SetAutoSizeColumns`	protected	Sets the value for the AutoSizeColumns property.
`DoAddItem`	protected	Signals the OnAddItem event handler when an entry is added to the Items in the control.
`GetBuiltinImageIndex`	protected	Gets the index position for the built-in icon used for the specified path or file name.
`GetListColumnClass`	protected
`Create`	public	Constructor for the class instance.
`Destroy`	public	Destructor for the class instance.
`AdjustColWidths`	public	Adjusts the width of columns in the list view according to the overall width for the control.
`FindColumn`	public
`FindAndSelectItem`	public
`GetPathFromItem`	public	Gets the path on the local file system for the specified item.
`Sort`	public	Sorts the values in Items using the SortType, SortColumn, and SortDirection for the control.
`UpdateColumn`	public
`UpdateView`	public	Reloads the contents for the list view control and restores the Selected item.

Events

`OnFileAdded`	protected	Event handler signalled when a file is added to the Items in the control.
`OnAddItem`	public	Event handler signalled to determine if the specified file information can be added to the Items for the list view.
`OnGetCellText`	public
`OnSortCompare`	public	Event handler signalled to perform a custom sort for the ObjectTypes in Items.