[Overview][Types][Classes][Procedures and functions][Index] | Reference for unit 'ShellCtrls' (#lcl)

# TCustomShellListView

[Properties (by Name)] [Methods (by Name)] [Events (by Name)]

The base class that defines a list view control to display the files, directories and other objects (such as devices) from the local file system.

## Declaration

Source position: shellctrls.pas line 257

`type TCustomShellListView = class(TCustomListView)`
`protected`
`class procedure WSRegisterClass; override;` |  | Registers an association between the class type and its widgetset class.
`procedure AdjustColWidths;` |  | Adjusts the width of columns in the list view according to the overall width for the control.
`procedure CreateHandle; override;` |  | Creates the handle for the control and populates the Items property.
`function CreateListItem; override;` |  | Create a new entry added to the Items for the shell control.
`procedure PopulateWithRoot;` |  | Fills the list view with file system information for the directory in Root.
`procedure DoOnResize; override;` |  | Adjusts column widths when the control is resized.
`procedure SetAutoSizeColumns(); virtual;` |  | Sets the value for the AutoSizeColumns property.
`procedure DoAddItem();` |  | Signals the OnAddItem event handler when an entry is added to the Items in the control.
`function GetBuiltinImageIndex();` |  | Gets the index position for the built-in icon used for the specified path or file name.
`property OnFileAdded: TCSLVFileAddedEvent; [rw]` |  | Event handler signalled when a file is added to the Items in the control.
`public`
`constructor Create(); override;` |  | Constructor for the class instance.
`destructor Destroy; override;` |  | Destructor for the class instance.
`function GetPathFromItem();` |  | Gets the path on the local file system for the specified item.
`procedure UpdateView;` |  | Reloads the contents for the list view control and restores the Selected item.
`property AutoSizeColumns: Boolean; [rw]` |  | Indicates if columns in the control are automatically resized to fill the client display area.
`property Mask: string; [rw]` |  | File mask used to select items displayed in the shell control.
`property MaskCaseSensitivity: TMaskCaseSensitivity; [rw]` |  | Case Sensitivity option enabled for file masks in the shell control.
`property ObjectTypes: TObjectTypes; [rw]` |  | Controls which file system objects are visible on the list view control.
`property Root: string; [rw]` |  | Indicates the initial directory path whose objects are displayed in the control.
`property ShellTreeView: TCustomShellTreeView; [rw]` |  | Used to connect the ShellListView to a ShellTreeView.
`property UseBuiltInIcons: Boolean; [rw]` |  | Indicates if icons provided by the OS or platform are used for items in the list.
`property OnAddItem: TAddItemEvent; [rw]` |  | Event handler signalled to determine if the specified file information can be added to the Items for the list view.
`property Items: TListItems;` |  | Collection of list items displayed on the list view control.
`end;`

## Inheritance

`TCustomShellListView` |  | The base class that defines a list view control to display the files, directories and other objects (such as devices) from the local file system.
`TCustomListView` |  | TCustomListView is the base class for TListView.
`TWinControl` |  | Implements a windowed control which can contain other child controls.
`TControl` |  | The base class for visible controls.
`TLCLComponent` |  | The base class for LCL components which have an associated widget.
`TComponent`
?
`TObject`

## 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 items in the control including:

- Mask
- MaskCaseSensitivity
- ObjectTypes
- Root
- ShellTreeView
- Items
- GetPathFromItem
- OnAddItem
- OnFileAdded

Application should not create instance of TCustomShellListView; use the TShellListView descendant which sets the scope for members in the class.

## See also

TCustomShellListView.Mask |  | File mask used to select items displayed in the shell control.
TCustomShellListView.MaskCaseSensitivity |  | Case Sensitivity option enabled for file masks in the shell control.
TCustomShellListView.ObjectTypes |  | Controls which file system objects are visible on the list view control.
TCustomShellListView.Root |  | Indicates the initial directory path whose objects are displayed in the control.
TCustomShellListView.ShellTreeView |  | Used to connect the ShellListView to a ShellTreeView.
TCustomShellListView.Items |  | Collection of list items displayed on the list view control.
TCustomShellListView.GetPathFromItem |  | Gets the path on the local file system for the specified item.
TCustomShellListView.OnAddItem |  | Event handler signalled to determine if the specified file information can be added to the Items for the list view.
TCustomShellListView.OnFileAdded |  | Event handler signalled when a file is added to the Items in the control.
TShellListView |  | Implements a list view control to display the files, directories and other objects (such as devices) on the local file system.