TcxCustomImageList.GetSourceFileName(Integer) Method

Returns the path to the source file of an image in the list.

Declaration

delphi

function GetSourceFileName(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 path to the source file of the image whose index is passed as the AIndex parameter.

The ASourceFileName parameter value of the Add function defines the source file name for added images. If the target image has no defined source file, the GetSourceFileName function returns an empty string.

Remarks

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

The GetSourceFileName function returns a source file name for an image if the name was passed to the Add function as the ASourceFileName parameter for the target image. AddImagesFromResZipStream and AddImagesFromZipStream procedure calls also store source file names for all added images.