Table of Contents

TXlsFile.SetImage Method

Sets the image data and / or image properties of an existing image. Note that for SVG images, xlsx files store both a PNG and SVG image. To enter an SVG image, use TExcelFile.SetImageAlternate

Syntax

Unit: FlexCel.XlsAdapter

procedure TXlsFile.SetImage(const imageIndex: Integer; data: TBytes; const imageType: TXlsImgType; const usesObjectIndex: Boolean; const objectPath: string); overload; override;

Parameters

<-> Parameter Type Description
const imageIndex Integer Index of the image on the sheet array (1-based)
data TBytes Image data.
const imageType TXlsImgType Image type of the new data.
const usesObjectIndex Boolean If false (the default) then imageIndex is an index to the list of images.
When true imageIndex is an index to the list of all objects in the sheet. When you have the object id, you can avoid calling TExcelFile.ObjectIndexToImageIndex which is a slow method, by setting this parameter to true.
const objectPath string Path to the object, when the object is grouped with others. This parameter only has meaning if usesObjectIndex is true.

If it is "absolute"(it starts with "\"), then the path includes the objectIndex, and the objectIndex is not used. An object path of "\1\2\3" is exactly the same as using objectIndex = 1 and objectPath = "2\3"

See also