Sign in Join
FPDoc Onlineexperiment

TComboExItems.AddItem function

Member of TComboExItemspublicIn unit ComboEx

Adds a new item with the specified values to the collection.

Declaration

pascal
function AddItem(const ACaption: string; AImageIndex: SmallInt=- 1; 
 AOverlayImageIndex: SmallInt=- 1; 
 ASelectedImageIndex: SmallInt=- 1; 
 AIndent: SmallInt=- 1; AData: TCustomData=Nil)
: TComboExItem

Arguments

ACaption

Caption for the item.

AImageIndex

Image index for the item.

AOverlayImageIndex

Overlay image index for the item.

ASelectedImageIndex

Selected image index for the item.

AIndent

Indent spacing for the item.

AData

Pointer to the arbitrary data associated with the item.

Function result

Item added to the collection.

Description

AddItem is a TComboExItem function used to add a new item to the collection with the values specified in the parameters passed to the method. AddItem calls the Add method to create a new TComboExItem instance. The following properties are updated in the collection item to use the values specified in the arguments:

  • Caption
  • indent
  • ImageIndex
  • OverlayImageIndex
  • SelectedImageIndex
  • Data

See also

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