TShellListView class

In unit ShellCtrls

Implements a list view control to display files or directories found on the local file system.

Declaration

pascal

TShellListView = class(TCustomShellListView)

Inheritance

Description

TShellListView is a TCustomShellListView descendant which implements a list view control for file system objects on the local file system. TShellListView extends the TListView 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.

See TListView for more information about methods, properties, and events introduced in the ancestor class.

Properties

`Align`	published	Specifies the placement of the control on its Parent control.
`AutoSizeColumns`	published	Indicates if columns in the control are automatically resized to fill the client display area.
`Anchors`	published	The set of anchor definitions for this control.
`BorderSpacing`	published	Determines the inner and outer border spacing for this control.
`BorderStyle`	published	Line style drawn as a border around the control.
`BorderWidth`	published	Width of the Border around the control; default is zero.
`Color`	published	The background color for the control.
`Columns`	published	Collection with the column definitions for the list view control (size, alignment, image index, etc.).
`Constraints`	published	Contains the minimum and maximum Width and Height for the control.
`DragCursor`	published	The cursor shape shown during a drag operation.
`DragMode`	published	Determines how a drag operation is started for the control.
`Enabled`	published	Determines whether the control responds to mouse or keyboard input.
`Font`	published	The font to be used for text display in this control.
`HideSelection`	published	If control looses focus, don't paint selection background for selected item(s).
`LargeImages`	published	Image list which contains "big" icons displayed for view styles on the control.
`LargeImagesWidth`	published	Contains the Width for the large images used in the list view.
`Mask`	published	File mask used to select items displayed in the shell control.
`MaskCaseSensitivity`	published	Case Sensitivity option enabled for file masks in the shell control.
`MultiSelect`	published	Allows simultaneous selection of one or more list items using Ctrl+Click, Shift+Click, Ctrl+Shift+Click, or using program code.
`ParentColor`	published	Uses the Color from the Parent control, when enabled.
`ParentFont`	published	Indicates if the Font from the Parent control is used in the control.
`ParentShowHint`	published	If True, the value of ShowHint for the control will be the same as the one from the Parent. Default is True.
`PopupMenu`	published	A context-sensitive menu that pops up when the right mouse button is clicked over this control.
`ReadOnly`	published	Disables editing of list items on the shell control when set to True.
`RowSelect`	published	Indicates if the entire row is highlighted when selected on the list view control.
`ScrollBars`	published	Specifies the scroll bars visible for the control.
`ShowColumnHeaders`	published	Show header area in ListView, which shows captions of columns.
`ShowHint`	published	Enables Hint display for the control.
`SmallImages`	published	Image list which contains "small" icons used for view styles.
`SmallImagesWidth`	published	Width for the images in the SmallImages property.
`SortColumn`	published	Ordinal position for the column used to sort the list items, or -1 when not assigned.
`SortDirection`	published	Sorting direction (order) for the current SortColumn.
`SortType`	published	Specifies the sorting mechanism used for the current SortColumn.
`StateImages`	published	Image list with the state images for the items on the control.
`TabStop`	published	Allows navigation to and from the control by pressing the Tab or Shift+Tab keys.
`TabOrder`	published	Indicates the navigation order for the control when the user presses the Tab or Shift+Tab key.
`ToolTips`	published	Indicates if a hint (tool tip) is automatically displayed for the list item under the mouse cursor.
`Visible`	published	Allows the control, and all of its children, to be displayed or hidden.
`ViewStyle`	published	Sets one of ListView layouts: List (simple column), Report (few columns with full width), Icon (big icons), Small Icon (small icons, 16x16).
`ObjectTypes`	published	Controls which file system objects are visible on the list view control.
`Root`	published	Indicates the initial directory path whose objects are displayed in the control.
`ShellTreeView`	published	Used to connect the ShellListView to a ShellTreeView.
`FileSortType`	published	Controls the sort order for object types displayed on the control.

Events

`OnChange`	published	Event handler signalled when the content for a list item is changed.
`OnClick`	published	Notification handler for mouse clicks.
`OnColumnClick`	published	Event handler signalled when a column header for the control is clicked.
`OnCompare`	published	Event handler signalled to compare list items in the CustomSort method.
`OnContextPopup`	published	Invoked when a context-sensitive pop-up menu is requested.
`OnDblClick`	published	Event handler signalled when a mouse double click occurs in the control.
`OnDeletion`	published	Event handler signalled when a list item is deleted from the Items container.
`OnDragDrop`	published	Event handler signalled when an object is dropped onto the control.
`OnDragOver`	published	Event handler signalled when a control is dragged over the control instance.
`OnEdited`	published	Event handler signalled prior to updating a list item caption when it has been edited in the control.
`OnEditing`	published	Event handler signalled to determine if editing can be performed for a list item in the control.
`OnEndDrag`	published	Event handler signalled for the end of a drag-drop operation.
`OnGetCellText`	published
`OnKeyDown`	published	Event handler signalled for key down keyboard events.
`OnKeyPress`	published	Event handler signalled for character data entered by the user.
`OnKeyUp`	published	Event handler signalled when a key up event has occurred for the control.
`OnMouseDown`	published	Event handler signalled when a mouse down event is handled for the control.
`OnMouseEnter`	published	Event handler signalled when the mouse pointer has entered the control.
`OnMouseLeave`	published	Event handler signalled when the mouse pointer has left the control.
`OnMouseMove`	published	Event handler signalled when the mouse pointer is moved in the control.
`OnMouseUp`	published	Event handler signalled when a mouse up event is handled for the control.
`OnMouseWheel`	published	Event handler for mouse wheel turned.
`OnMouseWheelDown`	published	Event handler signalled for a downward movement of the mouse wheel.
`OnMouseWheelUp`	published	Event handler signalled for an upward movement of the mouse wheel.
`OnMouseWheelHorz`	published	Event handler signalled for a horizontal movement of the mouse wheel.
`OnMouseWheelLeft`	published	Event handler signalled for a leftward movement of the mouse wheel.
`OnMouseWheelRight`	published	Event handler signalled for a rightward movement of the mouse wheel.
`OnResize`	published	Notification handler for a resize of the control.
`OnSelectItem`	published	Event handler signalled when the selected list item for the control is changed.
`OnStartDrag`	published	Event handler signalled for the start of a dragging operation.
`OnUTF8KeyPress`	published	Handler for a character entered by the user.
`OnAddItem`	published	Event handler signalled to determine if the specified file information can be added to the Items for the list view.
`OnFileAdded`	published	Event handler signalled when a file is added to the Items in the control.
`OnSortCompare`	published	Event handler signalled to perform a custom sort for the ObjectTypes in Items.