ExcelFile.ObjectPathToImageIndex Method
Returns the index on the image collection of an object. Note that this method is slow when there are many images, so use it sparingly. Whenever possible, prefer the methods that take directly an objectPath instead of converting the objectPath to an imageIndex.
Syntax
Namespace: FlexCel.Core
public abstract Int32 ObjectPathToImageIndex(Int32 objectIndex, String objectPath)Parameters
| <-> | Parameter | Type | Description |
|---|---|---|---|
| objectIndex | Int32 | Index of the object. | |
| objectPath | String | Index to the child object you want find. If it is a simple object, you can use String.Empty here, if not you need to get the ObjectPath from GetObjectProperties(Int32, Boolean) 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". You might also use the name of the object as objectpath, like ObjectPathToImageIndex(-1, "@myobjectname"); |
Returns
-1 if the object is not an image, else the index on the image collection.