TListView class

In unit ComCtrls

TListView - a window showing a list of Items which may or may not have associated icons.

Declaration

pascal

TListView = class(TCustomListView)

Inheritance

Description

TListView- a window showing a list of items which may or may not have associated icons.

At first this control looks very like TListBox but it has a much higher degree of complexity. It is capable of displaying Items in Columns of Rows and it can have images associated with the list Items.

The important information is held in Items, a string-list that can be created using the string-list editor obtained by right-clicking on the ListView in the Form Editor or by clicking on the ellipsis (...) next to the Items entry in the Object Inspector.

A typical application might have two image lists: LargeImages and SmallImages. They contain large and small sizes for the same collection of images. The index positions in the first list would correspond with those in the second list.

SmallImages (if assigned to a string-list) can be displayed beside the text strings in the list view and the programmer would supply code to ensure that when an item with its associated Small Image was selected, the corresponding Large Image would be displayed in another window.

One or more TImageList controls need to be added to the Form Designer and the ImageList Editor can be opened from the pop-up menu obtained by right-clicking on TImageList icon in the Form Designer. The image list can be populated by reading from files. Then in the StringList editor for Items the correct ImageIndex must be assigned to each entry in the list.

Properties

`Align`	published	Specifies the placement of the control on its Parent control.
`AllocBy`	published	Reduces allocation overhead in the widgetset class by increasing the internal buffer capacity by this block size.
`Anchors`	published	The set of anchor definitions for this control.
`AutoSort`	published	Controls automatic updates to the sort column and order indicator for the control.
`AutoSortIndicator`	published	Indicates if the control automatically changes the column and/or order indicator when a column is clicked.
`AutoWidthLastColumn`	published	Resizes the last visible column to fill the remaining display area for the 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.
`Checkboxes`	published	Displays a check box column for the list items on the control.
`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.).
`ColumnClick`	published	Enables or disables OnColumnClick events for column headers on the control.
`Constraints`	published	Contains the minimum and maximum Width and Height for the control.
`DragCursor`	published	The cursor shape shown during a drag operation.
`DragKind`	published	Indicates the action performed for a drag operation: drag-and-drop or drag-and-dock.
`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.
`GridLines`	published	Enables or disables grid lines between rows and columns on the control.
`HideSelection`	published	If control looses focus, don't paint selection background for selected item(s).
`IconOptions`	published	Options for layouts, which show icons. Sets arrangement of icons, text-wrapping state.
`Items`	published	Collection of list items displayed on the list view control.
`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.
`MultiSelect`	published	Allows simultaneous selection of one or more list items using Ctrl+Click, Shift+Click, Ctrl+Shift+Click, or using program code.
`OwnerData`	published	Enables or disables owner data (virtual) mode for the list view control.
`OwnerDraw`	published	Indicates if owner-draw mode is used for the control.
`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 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.
`StateImagesWidth`	published	Width of the images in the StateImages property.
`TabStop`	published	Allows the user to navigate to / 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).

Events

`OnAdvancedCustomDraw`	published	Event handler signalled to custom draw the grid control when the draw state is not cdPrePaint.
`OnAdvancedCustomDrawItem`	published	Event handler signalled to custom draw a list item on the grid control when the draw state is not cdPrePaint.
`OnAdvancedCustomDrawSubItem`	published	Event handler signalled to custom draw list sub-items when the draw stage is not cdPrePaint.
`OnChange`	published	Event handler signalled when the content for a list item is changed.
`OnChanging`	published	Event handler signalled when a change notification is received for a list item.
`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.
`OnCreateItemClass`	published	Event handler signalled to get the class reference used to create new list view items.
`OnCustomDraw`	published	Event handler signalled to perform custom drawing for the list view control.
`OnCustomDrawItem`	published	Event handler signalled to perform custom drawing for list items on the control.
`OnCustomDrawSubItem`	published	Event handler signalled to perform custom drawing for list sub-item on the control.
`OnData`	published	Event handler signalled to the value(s) for a list item when OwnerData (virtual mode) has been enabled.
`OnDataFind`	published	Event handler signalled to locate list item data when OwnerData (virtual) mode is enabled.
`OnDataHint`	published	Event handler signalled to load a range of cached list items in the virtual storage for the control.
`OnDataStateChange`	published	Not used in the current LCL version.
`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.
`OnDrawItem`	published	Event handler signalled to render an owner drawn item.
`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.
`OnEndDock`	published	Event handler signalled for the end of a drag-dock operation.
`OnEndDrag`	published	Event handler signalled for the end of a drag-drop operation.
`OnEnter`	published	Event handler signalled when the control receives focus.
`OnExit`	published	Event handler signalled when the control loses focus.
`OnInsert`	published	Event handler signalled when a list item is added to or inserted in the Items for the control.
`OnItemChecked`	published	Event handler signalled when the Checked property for a list item has been changed.
`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.
`OnShowHint`	published	Event handler signalled when a hint window is displayed for the control.
`OnStartDock`	published	Event handler for the start of a docking operation.
`OnStartDrag`	published	Event handler signalled for the start of a dragging operation.
`OnUTF8KeyPress`	published	Handler for a character entered by the user.