TcxCustomImageList.GetKeywords(Integer) Method

Returns keywords associated with an image in the list.

Declaration

delphi

function GetKeywords(AIndex: Integer): string;

Parameters

Name	Type	Description
AIndex	Integer

The target image index.

You can use the Count property to identify the number of images in the list.

Returns

Type	Description
string

The string with keywords associated with the image whose index is specified as the AIndex parameter.

The AKeywords parameter value of the Add function defines keywords for added images. If the target image has no keywords, the GetKeywords function returns an empty string.

Remarks

You can call GetSourceFileName and GetKeywords functions to obtain optional information on stored images.

The GetKeywords function returns a string with keywords for an image if it was passed to the Add function as the AKeywords parameter for the target image.