TXlsFile.ClearImage Method
Clears the image at position imageIndex, leaving an empty white box.
Syntax
Unit: FlexCel.XlsAdapter
procedure TXlsFile.ClearImage(const imageIndex: Integer; const usesObjectIndex: Boolean; const objectPath: string); overload; override;
Parameters
| <-> |
Parameter |
Type |
Description |
| const |
imageIndex |
Integer |
Index of the image to clear. (1 based) |
| 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