com.groupdocs.search.events

Class ImagePreparingEventArgs

java.lang.Object

com.groupdocs.search.events.EventArgs

com.groupdocs.search.events.BaseIndexEventArgs

com.groupdocs.search.events.ImagePreparingEventArgs

public class ImagePreparingEventArgs
extends BaseIndexEventArgs

Represents arguments for the event of an image preparing start.

Learn more

• Search index events

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ImagePreparingEventArgs(com.aspose.ms.System.Guid indexId, String indexFolder, IndexStatus status, String documentKey, String[] innerPath, int imageIndex, ImageFrame[] imageFrames, InputStream imageStream) Initializes a new instance of the ImagePreparingEventArgs class.

Method Summary

Modifier and Type	Method and Description
protected static ImagePreparingEventArgs	create(com.aspose.ms.System.Guid indexId, String indexFolder, IndexStatus status, String documentKey, String[] innerPath, int imageIndex, ImageFrame[] imageFrames, InputStream imageStream)
String	getDocumentKey() Gets the document key.
ImageFrame[]	getImageFrames() Gets the image frames.
int	getImageIndex() Gets the ordinal number of the image in the document.
InputStream	getImageStream() Gets the image stream.
String[]	getInnerPath() Gets the inner path of a nested document.

Methods inherited from class com.groupdocs.search.events.BaseIndexEventArgs

create, getIndexFolder, getIndexId, getStatus, getTime

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImagePreparingEventArgs

protected ImagePreparingEventArgs(com.aspose.ms.System.Guid indexId,
                                  String indexFolder,
                                  IndexStatus status,
                                  String documentKey,
                                  String[] innerPath,
                                  int imageIndex,
                                  ImageFrame[] imageFrames,
                                  InputStream imageStream)

Initializes a new instance of the ImagePreparingEventArgs class.

Parameters:

indexId - The index ID.

indexFolder - The index folder.

status - The status.

documentKey - The document key.

innerPath - The inner path of a nested document.

imageIndex - The ordinal number of the image in the document.

imageFrames - The image frames.

imageStream - The image stream.

Method Detail

create

protected static ImagePreparingEventArgs create(com.aspose.ms.System.Guid indexId,
                                                String indexFolder,
                                                IndexStatus status,
                                                String documentKey,
                                                String[] innerPath,
                                                int imageIndex,
                                                ImageFrame[] imageFrames,
                                                InputStream imageStream)

getDocumentKey

public final String getDocumentKey()

Gets the document key.

Returns:

The document key.

getImageFrames

public final ImageFrame[] getImageFrames()

Gets the image frames.

Returns:

The image frames.

getImageIndex

public final int getImageIndex()

Gets the ordinal number of the image in the document.

Returns:

The ordinal number of the image in the document.

getImageStream

public final InputStream getImageStream()

Gets the image stream.

Returns:

The image stream.

getInnerPath

public final String[] getInnerPath()

Gets the inner path of a nested document.

Returns:

The inner path of a nested document.