ImageSavingArgs

ImageSavingArgs

Overview

ImageSavingArgs is a class in Aspose.Words FOSS for Java.

Provides data for the IImageSavingCallback.imageSaving() event.

Edition status of its 15 listed members (a property and its accessor methods are listed separately, overloads once): 15 not yet exercised by a verified example.

This class declares 9 methods for ImageSavingArgs objects in Java programs. Available methods include: getCurrentShape, getDocument, getImageFileName, getImageStream, getKeepImageStreamOpen, isImageAvailable, setImageFileName, setImageStream, setKeepImageStreamOpen. Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package. Properties: currentShape, document, imageAvailable, imageFileName, imageStream, keepImageStreamOpen.

Properties

NameTypeAccessDescription
documentDocumentReadGets the document object that is currently being saved.
currentShapeShapeBaseReadGets the ShapeBase object corresponding to the shape or group shape that is about to be saved.
imageAvailablebooleanReadReturns true if the current image is available for export.
imageFileNameStringRead/WriteGets or sets the file name (without path) where the image will be saved to.
keepImageStreamOpenbooleanRead/WriteSpecifies whether Aspose.Words should keep the stream open or close it after saving an image.
imageStreamjava.io.OutputStreamRead/WriteGets or sets the image stream.

Methods

SignatureDescription
getDocument() → DocumentGets the document object that is currently being saved.
getCurrentShape() → ShapeBaseGets the ShapeBase object corresponding to the shape or group shape that is about to be saved.
isImageAvailable() → booleanReturns true if the current image is available for export.
getImageFileName() → StringGets or sets the file name (without path) where the image will be saved to.
setImageFileName(value: String)Sets the image file name value.
getKeepImageStreamOpen() → booleanSpecifies whether Aspose.Words should keep the stream open or close it after saving an image.
setKeepImageStreamOpen(value: boolean)Sets the keep image stream open value.
getImageStream() → java.io.OutputStreamReturns the image stream.
setImageStream(value: java.io.OutputStream)Sets the image stream value.

See Also