TExcelFile.GetImageProperties Method
Overloads
TExcelFile.GetImageProperties(Integer)
Returns image position and size.
Syntax
Unit: FlexCel.Core
function TExcelFile.GetImageProperties(const imageIndex: Integer): IImageProperties; overload;
Parameters
| <-> |
Parameter |
Type |
Description |
| const |
imageIndex |
Integer |
Index of the image (1 based) |
Returns
Image position and size.
See also
TExcelFile.GetImageProperties(Integer, Boolean, string)
Returns image position and size.
Syntax
Unit: FlexCel.Core
function TExcelFile.GetImageProperties(const imageIndex: Integer; const usesObjectIndex: Boolean; const objectPath: string): IImageProperties; overload; virtual; abstract;
Parameters
| <-> |
Parameter |
Type |
Description |
| const |
imageIndex |
Integer |
Index of the image (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 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" |
Returns
Image position and size.
See also