com.aspose.words
Class ExportImageSavingEventArgs

java.lang.Object
    com.aspose.words.ExportImageSavingEventArgs

public class ExportImageSavingEventArgs 
extends java.lang.Object

public Shape getCurrentShape()

Gets the Shape object that contains the image that is about to be saved.

Aspose.Words uses the document file name and a unique number to generate unique file name for each image found in the document. You can use the CurrentShape property to generate a "better" file name by examining shape properties such as ImageData.Title, ImageData.SourceFullName and ShapeBase.Name.

Some images in the document can be unavailable. To check image availability use the IsImageAvailable property.

public boolean isImageAvailable()

Returns true if the current image is available for export.

Some images in the document can be unavailable, for example, because the image is linked and the link does not point to a valid image. In this case Aspose.Words exports an icon with a red cross. This property returns true if the original image is available; returns false if the original image is not available and a "no image" icon will be offered for save.

See Also:

CurrentShape

public java.lang.String getImageFileName() / public void setImageFileName(java.lang.String value)

Gets or sets the file name (without path) where the image will be saved to.

This property allows you to redefine how the image file names are generated during export to HTML.

When the event is fired, this property contains the file name that was generated by Aspose.Words. You can change the value of this property to save the image into a different file. Note that file names must be unique.

Aspose.Words automatically generates a unique file name for every embedded image when exporting to HTML format. How the image file name is generated depends on whether you save the document to a file or to a stream.

When saving a document to a file, the generated image file name looks like <document base file name>.<image number>.<extension>.

When saving a document to a stream, the generated image file name looks like Aspose.Words.<document guid>.<image number>.<extension>.

ImageFileName must contain only the file name without the path. Aspose.Words determines the path for saving and the value of the src attribute for writing to HTML using the document file name, the SaveOptions.HtmlExportImagesFolder and SaveOptions.HtmlExportImagesFolderAlias properties.

See Also:

CurrentShape, IsImageAvailable, ImageStream, SaveOptions.HtmlExportImagesFolder, SaveOptions.HtmlExportImagesFolderAlias

public java.io.OutputStream getImageStream() / public void setImageStream(java.io.OutputStream value)

Allows to specify the stream where the image will be saved to.

This property allows you to save images to streams instead of files during export HTML.

The default value is null. When this property is null, the image will be saved to a file specified in the ImageFileName property.

See Also:

ImageFileName, KeepImageStreamOpen

public boolean getKeepImageStreamOpen() / public void setKeepImageStreamOpen(boolean value)

Specifies whether Aspose.Words should keep the stream open or close it after saving an image.

Default is false and Aspose.Words will close the stream you provided in the ImageStream property after writing an image into it. Specify true to keep the stream open.

See Also:

ImageStream