[Overview][Constants][Types][Classes][Index] Reference for unit 'ComCtrls' (#lcl)

TListView

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

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

Declaration

Source position: comctrls.pp line 1581

type TListView = class(TCustomListView)

published

  property Align: TAlign;

  

Specifies the placement of the control inside its Parent.

  property AllocBy: Integer;

  property Anchors: TAnchors;

  

The set of anchor definitions for this control.

  property AutoSort: Boolean;

  property AutoWidthLastColumn: Boolean; [rw]

  property BorderSpacing: TControlBorderSpacing;

  

Determines the inner and outer border spacing for this control.

  property BorderStyle: TBorderStyle;

  

Allows to show a border (line) around the control,

  property BorderWidth: TBorderWidth;

  

Width of the Border around the control; default is zero.

  property Checkboxes: Boolean;

  

CheckBoxes - determines if the ListView shows checkboxes beside the items on the list

  property Color: TColor;

  

The background color of the control.

  property Columns: TListColumns;

  

Columns - define and change the columns of a ListView

  property ColumnClick: Boolean;

  

ColumnClick - determines if the OnColumnClick event will be executed.

  property Constraints: TSizeConstraints;

  

The minimal and maximal Width and Height of this control.

  property DragCursor: TCursor;

  

The cursor shape shown while the control is dragged.

  property DragKind: TDragKind;

  property DragMode: TDragMode;

  

Allows the user to drag the control.

  property Enabled: Boolean;

  

Determines whether the control reacts on mouse or keyboard input.

  property Font: TFont;

  

The font to be used for text display in this control.

  property GridLines: Boolean;

  property HideSelection: Boolean;

  

HideSelection - render the selected items invisible

  property IconOptions: TIconOptions;

  property Items: TListItems;

  

Items - the list of entries in the list. Held as a linked list with a cached index of the last accessed item

  property LargeImages: TCustomImageList;

  

LargeImages - an ImageList to be used in association with the list of Items

  property MultiSelect: Boolean;

  

MultiSelect - enables the selection of more than one entry from Items - by pressing SHIFT or CTRL keys while selecting

  property OwnerData: Boolean;

  property OwnerDraw: Boolean;

  property ParentColor: Boolean;

  

If true, the Color of the control will be the same as the one from the Parent. Default is true.

  property ParentFont: Boolean;

  

If true, the Font of the control will be the same as the one from the Parent. Default is true.

  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;

  

ReadOnly - determines if the list can only be read, and not written or deleted.

  property RowSelect: Boolean;

  

RowSelect - whether the user can select rows of items (across columns). Default false

  property ScrollBars: TScrollStyle;

  

ScrollBars - the kind of scrollbars to be used: none, auto, horizontal or vertical

  property ShowColumnHeaders: Boolean;

  

ShowColumnHeaders - whether headers for columns are to be displayed

  property ShowHint: Boolean;

  

Enables the Hint display.

  property SmallImages: TCustomImageList;

  

SmallImages - an ImageList of small images (icons) to be used in association with the list of Items

  property SortColumn: Integer;

  

SortColumn - the column that is being sorted

  property SortDirection: TSortDirection;

  property SortType: TSortType;

  

SortType - whether to sort by text, by data, both or not at all

  property StateImages: TCustomImageList;

  

StateImages - an imagelist of icons to demonstrate the state of a process or event

  property TabStop: Boolean;

  

Allows the user to navigate to this control, by pressing the Tab key.

  property TabOrder: TTabOrder;

  

Determines the sequence of controls, reachable when the user presses the Tab key.

  property ToolTips: Boolean;

  

ToolTips - whether Popup tool tips are to be shown

  property Visible: Boolean;

  

Allows to show or hide the control, and all of its children.

  property ViewStyle: TViewStyle;

  

ViewStyle - whether to view as a simple list, a list with large or small icons, or as a report

  property OnAdvancedCustomDraw: TLVAdvancedCustomDrawEvent;

  

OnAdvancedCustomDraw - event handler for advanced custom drawing

  property OnAdvancedCustomDrawItem: TLVAdvancedCustomDrawItemEvent;

  

OnAdvancedCustomDrawItem - event handler for advanced custom drawing item

  property OnAdvancedCustomDrawSubItem: TLVAdvancedCustomDrawSubItemEvent;

  

OnAdvancedCustomDrawSubItem - event handler for advanced custom drawing subitem

  property OnChange: TLVChangeEvent;

  

OnChange - event handler for a change in the list

  property OnClick: TNotifyEvent;

  

Notification handler for mouse clicks.

  property OnColumnClick: TLVColumnClickEvent;

  

OnColumnClick - event handler for clicking on a coulmn

  property OnCompare: TLVCompareEvent;

  

OnCompare - event handler for comparing list items

  property OnContextPopup: TContextPopupEvent;

  

Invoked when a context-sensitive pop-up menu is requested.

  property OnCreateItemClass: TLVCreateItemClassEvent;

  property OnCustomDraw: TLVCustomDrawEvent;

  

OnCustomDraw - event handler for custom drawing

  property OnCustomDrawItem: TLVCustomDrawItemEvent;

  

OnCustomDrawItem - event handler for custom drawing an item

  property OnCustomDrawSubItem: TLVCustomDrawSubItemEvent;

  

OnCustomDrawSubItem - event handler for custom drawing a subitem

  property OnData: TLVDataEvent;

  property OnDataFind: TLVDataFindEvent;

  property OnDataHint: TLVDataHintEvent;

  property OnDataStateChange: TLVDataStateChangeEvent;

  property OnDblClick: TNotifyEvent;

  

Event Handler for double mouse clicks.

  property OnDeletion: TLVDeletedEvent;

  

OnDeletion - event handler for deleting a list item

  property OnDragDrop: TDragDropEvent;

  

This handler determines the action on an drop onto this control, in a drag-drop operation.

  property OnDragOver: TDragOverEvent;

  

Event handler for a control being dragged over this control.

  property OnDrawItem: TLVDrawItemEvent;

  property OnEdited: TLVEditedEvent;

  property OnEditing: TLVEditingEvent;

  property OnEndDock: TEndDragEvent;

  property OnEndDrag: TEndDragEvent;

  

Notification handler for the end of a dragging operation.

  property OnEnter: TNotifyEvent;

  property OnExit: TNotifyEvent;

  property OnItemChecked: TLVCheckedItemEvent;

  property OnKeyDown: TKeyEvent;

  

Handler for keyboard key pressed.

  property OnKeyPress: TKeyPressEvent;

  

Handler for a character entered by the user.

  property OnKeyUp: TKeyEvent;

  

Handler for keyboard key released.

  property OnMouseDown: TMouseEvent;

  

Event handler for mouse button going down.

  property OnMouseEnter: TNotifyEvent;

  property OnMouseLeave: TNotifyEvent;

  property OnMouseMove: TMouseMoveEvent;

  

Event handler for mouse movement within the control.

  property OnMouseUp: TMouseEvent;

  

Event handler for mouse button going up.

  property OnResize: TNotifyEvent;

  

Notification handler for a resize of the control.

  property OnSelectItem: TLVSelectItemEvent;

  

OnSelectItem - event handler for list item selection

  property OnStartDock: TStartDockEvent;

  property OnStartDrag: TStartDragEvent;

  

Event handler for the start of a dragging operation.

  property OnUTF8KeyPress: TUTF8KeyPressEvent;

  

Handler for a character entered by the user.

end;

Inheritance

TListView

  

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

|

TCustomListView

  

TCustomListView - the base class for TListView

|

TWinControl

  

The base class for controls which can contain other (child) controls.

|

TControl

  

The base class for visible controls.

|

TLCLComponent

  

The base class for LCL components associated with widgets.

|

TComponent

?

TObject

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 ImageLists: one ofLargeImages and one of SmallImages, containing two versions of the same collection of images, in large and small format; the index numbers of 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 selected and pasted on 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 allocated to each entry in the list.