ImageSavingArgs class

ImageSavingArgs class

Provides data for the IImageSavingCallback.image_saving() event. To learn more, visit the Save a Document documentation article.


By default, when Aspose.Words saves a document to HTML, it saves each image into a separate file. Aspose.Words uses the document file name and a unique number to generate unique file name for each image found in the document.

ImageSavingArgs allows to redefine how image file names are generated or to completely circumvent saving of images into files by providing your own stream objects.

To apply your own logic for generating image file names use the ImageSavingArgs.image_file_name, ImageSavingArgs.current_shape and ImageSavingArgs.is_image_available properties.

To save images into streams instead of files, use the ImageSavingArgs.image_stream property.


current_shapeGets the ShapeBase object corresponding to the shape or group shape that is about to be saved.
documentGets the document object that is currently being saved.
image_file_nameGets or sets the file name (without path) where the image will be saved to.
image_streamAllows to specify the stream where the image will be saved to.
is_image_availableReturns True if the current image is available for export.
keep_image_stream_openSpecifies whether Aspose.Words should keep the stream open or close it after saving an image.

See Also