ImagePreparingEventArgs
Inheritance: java.lang.Object, com.groupdocs.search.events.EventArgs, com.groupdocs.search.events.BaseIndexEventArgs
public class ImagePreparingEventArgs extends BaseIndexEventArgs
Represents arguments for the event of an image preparing start.
Learn more
Methods
| Method | Description |
|---|---|
| getDocumentKey() | Gets the document key. |
| getInnerPath() | Gets the inner path of a nested document. |
| getImageIndex() | Gets the ordinal number of the image in the document. |
| getImageFrames() | Gets the image frames. |
| getImageStream() | Gets the image stream. |
getDocumentKey()
public final String getDocumentKey()
Gets the document key.
Returns: java.lang.String - The document key.
getInnerPath()
public final String[] getInnerPath()
Gets the inner path of a nested document.
Returns: java.lang.String[] - The inner path of a nested document.
getImageIndex()
public final int getImageIndex()
Gets the ordinal number of the image in the document.
Returns: int - The ordinal number of the image in the document.
getImageFrames()
public final ImageFrame[] getImageFrames()
Gets the image frames.
Returns: com.groupdocs.search.common.ImageFrame[] - The image frames.
getImageStream()
public final InputStream getImageStream()
Gets the image stream.
Returns: java.io.InputStream - The image stream.