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

# TShellListView

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

Implements a list view control to display the files, directories and other objects (such as devices) on the local file system.

## Declaration

Source position: shellctrls.pas line 310

`type TShellListView = class(TCustomShellListView)`
`public`
`property Columns: TListColumns;` |  | Collection with the column definitions for the list view control (size, alignment, image index, etc.).
`published`
`property Align: TAlign;` |  | Specifies the placement of the control on its Parent control.
`property AutoSizeColumns: Boolean;` |  | Indicates if columns in the control are automatically resized to fill the client display area.
`property Anchors: TAnchors;` |  | The set of anchor definitions for this control.
`property BorderSpacing: TControlBorderSpacing;` |  | Determines the inner and outer border spacing for this control.
`property BorderStyle: TBorderStyle;` |  | Line style drawn as a border around the control.
`property BorderWidth: TBorderWidth;` |  | Width of the Border around the control; default is zero.
`property Color: TColor;` |  | The background color for the control.
`property Constraints: TSizeConstraints;` |  | Contains the minimum and maximum Width and Height for the control.
`property DragCursor: TCursor;` |  | The cursor shape shown during a drag operation.
`property DragMode: TDragMode;` |  | Determines how a drag operation is started for the control.
`property Enabled: Boolean;` |  | Determines whether the control responds to mouse or keyboard input.
`property Font: TFont;` |  | The font to be used for text display in this control.
`property HideSelection: Boolean;` |  | If control looses focus, don't paint selection background for selected item(s).
`property LargeImages: TCustomImageList;` |  | Image list which contains "big" icons displayed for view styles on the control.
`property LargeImagesWidth: Integer;` |  | Contains the Width for the large images used in the list view.
`property Mask: string;` |  | File mask used to select items displayed in the shell control.
`property MaskCaseSensitivity: TMaskCaseSensitivity;` |  | Case Sensitivity option enabled for file masks in the shell control.
`property MultiSelect: Boolean;` |  | Allows simultaneous selection of one or more list items using Ctrl+Click, Shift+Click, Ctrl+Shift+Click, or using program code.
`property ParentColor: Boolean;` |  | Uses the Color from the Parent control, when enabled.
`property ParentFont: Boolean;` |  | Indicates if the Font from the Parent control is used in the control.
`property ParentShowHint: Boolean;` |  | If True, the value of ShowHint for the control will be the same as the one from the Parent. Default is True.
`property PopupMenu: TPopupMenu;` |  | A context-sensitive menu that pops up when the right mouse button is clicked over this control.
`property ReadOnly: Boolean;` |  | Disables editing of list items on the shell control when set to True.
`property RowSelect: Boolean;` |  | Indicates if the entire row is highlighted when selected on the list view control.
`property ScrollBars: TScrollStyle;` |  | Specifies the scroll bars visible for the control.
`property ShowColumnHeaders: Boolean;` |  | Show header area in ListView, which shows captions of columns.
`property ShowHint: Boolean;` |  | Enables Hint display for the control.
`property SmallImages: TCustomImageList;` |  | Image list which contains "small" icons used for view styles.
`property SmallImagesWidth: Integer;` |  | Width for the images in the SmallImages property.
`property SortColumn: Integer;` |  | Ordinal position for the column used to sort the list items, or -1 when not assigned.
`property SortType: TSortType;` |  | Specifies the sorting mechanism used for the current SortColumn.
`property StateImages: TCustomImageList;` |  | Image list with the state images for the items on the control.
`property TabStop: Boolean;` |  | Allows navigation to and from the control by pressing the Tab or Shift+Tab keys.
`property TabOrder: TTabOrder;` |  | Indicates the navigation order for the control when the user presses the Tab or Shift+Tab key.
`property ToolTips: Boolean;` |  | Indicates if a hint (tool tip) is automatically displayed for the list item under the mouse cursor.
`property Visible: Boolean;` |  | Allows the control, and all of its children, to be displayed or hidden.
`property ViewStyle: TViewStyle;` |  | Sets one of ListView layouts: List (simple column), Report (few columns with full width), Icon (big icons), Small Icon (small icons, 16x16).
`property ObjectTypes: TObjectTypes;` |  | Controls which file system objects are visible on the list view control.
`property Root: string;` |  | Indicates the initial directory path whose objects are displayed in the control.
`property ShellTreeView: TCustomShellTreeView;` |  | Used to connect the ShellListView to a ShellTreeView.
`property OnChange: TLVChangeEvent;` |  | Event handler signalled when the content for a list item is changed.
`property OnClick: TNotifyEvent;` |  | Notification handler for mouse clicks.
`property OnColumnClick: TLVColumnClickEvent;` |  | Event handler signalled when a column header for the control is clicked.
`property OnCompare: TLVCompareEvent;` |  | Event handler signalled to compare list items in the CustomSort method.
`property OnContextPopup: TContextPopupEvent;` |  | Invoked when a context-sensitive pop-up menu is requested.
`property OnDblClick: TNotifyEvent;` |  | Event handler signalled when a mouse double click occurs in the control.
`property OnDeletion: TLVDeletedEvent;` |  | Event handler signalled when a list item is deleted from the Items container.
`property OnDragDrop: TDragDropEvent;` |  | Event handler signalled when an object is dropped onto the control.
`property OnDragOver: TDragOverEvent;` |  | Event handler signalled when a control is dragged over the control instance.
`property OnEdited: TLVEditedEvent;` |  | Event handler signalled prior to updating a list item caption when it has been edited in the control.
`property OnEditing: TLVEditingEvent;` |  | Event handler signalled to determine if editing can be performed for a list item in the control.
`property OnEndDrag: TEndDragEvent;` |  | Event handler signalled for the end of a drag-drop operation.
`property OnKeyDown: TKeyEvent;` |  | Event handler signalled for key down keyboard events.
`property OnKeyPress: TKeyPressEvent;` |  | Event handler signalled for character data entered by the user.
`property OnKeyUp: TKeyEvent;` |  | Event handler signalled when a key up event has occurred for the control.
`property OnMouseDown: TMouseEvent;` |  | Event handler signalled when a mouse down event is handled for the control.
`property OnMouseEnter: TNotifyEvent;` |  | Event handler signalled when the mouse pointer has entered the control.
`property OnMouseLeave: TNotifyEvent;` |  | Event handler signalled when the mouse pointer has left the control.
`property OnMouseMove: TMouseMoveEvent;` |  | Event handler signalled when the mouse pointer is moved in the control.
`property OnMouseUp: TMouseEvent;` |  | Event handler signalled when a mouse up event is handled for the control.
`property OnMouseWheel: TMouseWheelEvent;` |  | Event handler for mouse wheel turned.
`property OnMouseWheelDown: TMouseWheelUpDownEvent;` |  | Event handler signalled for a downward movement of the mouse wheel.
`property OnMouseWheelUp: TMouseWheelUpDownEvent;` |  | Event handler signalled for an upward movement of the mouse wheel.
`property OnMouseWheelHorz: TMouseWheelEvent;` |  | Event handler signalled for a horizontal movement of the mouse wheel.
`property OnMouseWheelLeft: TMouseWheelUpDownEvent;` |  | Event handler signalled for a leftward movement of the mouse wheel.
`property OnMouseWheelRight: TMouseWheelUpDownEvent;` |  | Event handler signalled for a rightward movement of the mouse wheel.
`property OnResize: TNotifyEvent;` |  | Notification handler for a resize of the control.
`property OnSelectItem: TLVSelectItemEvent;` |  | Event handler signalled when the selected list item for the control is changed.
`property OnStartDrag: TStartDragEvent;` |  | Event handler signalled for the start of a dragging operation.
`property OnUTF8KeyPress: TUTF8KeyPressEvent;` |  | Handler for a character entered by the user.
`property OnAddItem: TAddItemEvent;` |  | Event handler signalled to determine if the specified file information can be added to the Items for the list view.
`property OnFileAdded: TCSLVFileAddedEvent;` |  | Event handler signalled when a file is added to the Items in the control.
`end;`

## Inheritance

`TShellListView` |  | Implements a list view control to display the files, directories and other objects (such as devices) on the local file system.
`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

TShellListView is a TCustomShellListView descendant which implements a list view control for file system objects on the local file system. TShellListView contains properties, methods, and events needed to access and maintain items in the control including:

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

## See also

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