TListItem class

In unit ComCtrls

Represents the items created in TCustomListView and descendants.

Declaration

pascal

TListItem = class(TPersistent)

Inheritance

TListItem
TPersistent
TObject

Descends from it: TOwnerDataListItem TShellListItem

Description

TListItem is the base class for the Items created in TCustomListView and TListView.

TListItem provides properties which identify the content for the list item, like: Caption, SubItems, Data, Index, ImageIndex, and StateIndex. Other properties indicate the disposition of the item in the control, like: Checked, Cut, DropTarget, Focused, and Selected.

Methods are provided that allow the list item to interact with the control and the widgetset class.

TListItem is the type stored in the TListItems container.

Properties

`Caption`	public	Caption - the name given to this item on the list.
`Checked`	public	Displays a check mark to allow the list item to be include in list view operations.
`Cut`	public	Indicates if the list item has been cut from the list but it can be pasted to the clipboard.
`Data`	public	Pointer to arbitrary Data associated with the list item.
`DropTarget`	public	True if the list item is a highlighted drop target in the list view control.
`Focused`	public	True if the list item is focused on the list view control.
`Index`	public	Ordinal position for the list item in its TListItems container.
`ImageIndex`	public	Ordinal position for the image displayed for the list item.
`Left`	public	The position of the Left side of the list item.
`ListView`	public	The ListView in which this Item is found.
`Owner`	public	Container that is the Owner of the list item.
`Position`	public	The coordinates where the list item is located on its list view control.
`Selected`	public	Whether this Item has been Selected (often denoted by a check-mark).
`StateIndex`	public	Ordinal position for the image used to represent the state for the list item.
`SubItems`	public	Contains text displayed as additional columns on the list view control.
`SubItemImages`	public	Gets the ImageIndex for the sub-item at the specified position.
`Top`	public	Top coordinate for the list item.

Methods

`IsEqual`	protected	Determines if the specified list item has the same values as the current class instance.
`IsOwnerData`	protected	Determines if the list item has an owner with a valid handle.
`GetCheckedInternal`	protected	True if the member variable for the Checked property contains True.
`GetOwner`	protected	Gets the owner of the class instance.
`Assign`	public	Copies values from the specified persistent object into the current class instance.
`Create`	public	Constructor for the class instance.
`Destroy`	public	Destructor for the class instance.
`Delete`	public	Removes the list item from the container.
`MakeVisible`	public	Makes the item visible in the list view control which owns the list item.
`DisplayRect`	public	Gets the display rectangle for the specified region of the list item on its list view control.
`DisplayRectSubItem`	public	Gets the display rectangle coordinates for a region in the specified sub-item on its list view control.
`EditCaption`	public	Selects the list item and displays its editor when possible.
`GetStates`	public	Returns all the states for the list item.

Inherited

From TPersistent (6)

AssignTo DefineProperties FPOAttachObserver FPODetachObserver FPONotifyObservers GetNamePath

From TObject (40)

AfterConstruction BeforeDestruction CheckDisposed ClassInfo ClassName ClassNameIs ClassParent ClassType CleanupInstance DefaultHandler DefaultHandlerStr Dispatch DispatchStr Disposed DisposeOf Equals FieldAddress Free FreeInstance GetDisposed GetHashCode GetInterface GetInterfaceByStr GetInterfaceEntry GetInterfaceEntryByStr GetInterfaceTable GetInterfaceWeak GetLastCastErrorInfo InheritsFrom InitInstance InstanceSize MethodAddress MethodName newinstance QualifiedClassName SafeCallException StringMessageTable SystemHasExtendedRTTI ToString UnitName

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.