[Overview][Constants][Types][Classes][Procedures and functions][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 1631

type TListView = class(TCustomListView) end;

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;

  property Color: TColor;

  

The background color of the control.

  property Columns: TListColumns;

  

  property ColumnClick: Boolean;

  

  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;

  property IconOptions: TIconOptions;

  property Items: TListItems;

  

  property LargeImages: TCustomImageList;

  

  property MultiSelect: Boolean;

  

  property OwnerData: Boolean;

  property OwnerDraw: Boolean;

  property ParentColor: Boolean;

  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;

  property RowSelect: Boolean;

  

  property ScrollBars: TScrollStyle;

  

  property ShowColumnHeaders: Boolean;

  

  property ShowHint: Boolean;

  

Enables the Hint display.

  property SmallImages: TCustomImageList;

  

  property SortColumn: Integer;

  

  property SortDirection: TSortDirection;

  property SortType: TSortType;

  

  property StateImages: TCustomImageList;

  

  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;

  property Visible: Boolean;

  

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

  property ViewStyle: TViewStyle;

  

  property OnAdvancedCustomDraw: TLVAdvancedCustomDrawEvent;

  property OnAdvancedCustomDrawItem: TLVAdvancedCustomDrawItemEvent;

  property OnAdvancedCustomDrawSubItem: TLVAdvancedCustomDrawSubItemEvent;

  property OnChange: TLVChangeEvent;

  

  property OnClick: TNotifyEvent;

  

Notification handler for mouse clicks.

  property OnColumnClick: TLVColumnClickEvent;

  

  property OnCompare: TLVCompareEvent;

  

  property OnContextPopup: TContextPopupEvent;

  

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

  property OnCreateItemClass: TLVCreateItemClassEvent;

  property OnCustomDraw: TLVCustomDrawEvent;

  property OnCustomDrawItem: TLVCustomDrawItemEvent;

  property OnCustomDrawSubItem: TLVCustomDrawSubItemEvent;

  property OnData: TLVDataEvent;

  property OnDataFind: TLVDataFindEvent;

  property OnDataHint: TLVDataHintEvent;

  property OnDataStateChange: TLVDataStateChangeEvent;

  property OnDblClick: TNotifyEvent;

  

Event Handler for double mouse clicks.

  property OnDeletion: TLVDeletedEvent;

  

  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 OnInsert: TLVInsertEvent;

  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 OnMouseWheel: TMouseWheelEvent;

  property OnMouseWheelDown: TMouseWheelUpDownEvent;

  property OnMouseWheelUp: TMouseWheelUpDownEvent;

  property OnResize: TNotifyEvent;

  

Notification handler for a resize of the control.

  property OnSelectItem: TLVSelectItemEvent;

  

  property OnShowHint: TControlShowHintEvent;

  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.

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.

The latest version of this document can be found at lazarus-ccr.sourceforge.net.