Provides data for the ImageSaving() event.
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 ImageFileName, CurrentShape and IsImageAvailable properties.
To save images into streams instead of files, use the ImageStream property.
Shows how to split a document into parts and save them.
#include <Aspose.Words.Cpp/Saving/ImageSavingArgs.h>
Public Member Functions | |
SharedPtr< ShapeBase > | get_CurrentShape () const |
Gets the ShapeBase object corresponding to the shape or group shape that is about to be saved. More... | |
SharedPtr< Document > | get_Document () |
Gets the document object that is currently being saved. More... | |
String | get_ImageFileName () const |
Gets or sets the file name (without path) where the image will be saved to. More... | |
SharedPtr< Stream > | get_ImageStream () const |
Allows to specify the stream where the image will be saved to. More... | |
bool | get_IsImageAvailable () const |
Returns true if the current image is available for export. More... | |
bool | get_KeepImageStreamOpen () const |
Specifies whether Aspose.Words should keep the stream open or close it after saving an image. More... | |
virtual const TypeInfo & | GetType () const override |
virtual bool | Is (const TypeInfo &target) const override |
void | set_ImageFileName (String value) |
Setter for get_ImageFileName. More... | |
void | set_ImageStream (SharedPtr< Stream > value) |
Setter for get_ImageStream. More... | |
void | set_KeepImageStreamOpen (bool value) |
Setter for get_KeepImageStreamOpen. More... | |
Static Public Member Functions | |
static const TypeInfo & | Type () |
System::SharedPtr<Aspose::Words::Drawing::ShapeBase> Aspose::Words::Saving::ImageSavingArgs::get_CurrentShape | ( | ) | const |
Gets the ShapeBase object corresponding to the shape or group shape that is about to be saved.
IImageSavingCallback can be fired while saving either a shape or a group shape. That's why the property has ShapeBase type. You can check whether it's a group shape comparing ShapeType with Group or by casting it to one of derived classes: Shape or GroupShape.
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 Title (Shape only), SourceFullName (Shape only) and Name. Of course you can build file names using any other properties or criteria but note that subsidiary file names must be unique within the export operation.
Some images in the document can be unavailable. To check image availability use the IsImageAvailable property.
Shows how to involve an image saving callback in an HTML conversion process.
System::SharedPtr<Aspose::Words::Document> Aspose::Words::Saving::ImageSavingArgs::get_Document | ( | ) |
Gets the document object that is currently being saved.
Shows how to involve an image saving callback in an HTML conversion process.
System::String Aspose::Words::Saving::ImageSavingArgs::get_ImageFileName | ( | ) | const |
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 ImagesFolder and ImagesFolderAlias properties.
Shows how to split a document into parts and save them.
System::SharedPtr<System::IO::Stream> Aspose::Words::Saving::ImageSavingArgs::get_ImageStream | ( | ) | const |
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 HTML.
The default value is null
. When this property is null
, the image will be saved to a file specified in the ImageFileName property.
Using IImageSavingCallback you cannot substitute one image with another. It is intended only for control over location where to save images.
Shows how to involve an image saving callback in an HTML conversion process.
bool Aspose::Words::Saving::ImageSavingArgs::get_IsImageAvailable | ( | ) | const |
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 is inaccessible or 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.
When saving a group shape or a shape that doesn't require any image this property is always true
.
Shows how to involve an image saving callback in an HTML conversion process.
bool Aspose::Words::Saving::ImageSavingArgs::get_KeepImageStreamOpen | ( | ) | const |
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.
Shows how to involve an image saving callback in an HTML conversion process.
|
overridevirtual |
Reimplemented from System::Object.
|
overridevirtual |
Reimplemented from System::Object.
void Aspose::Words::Saving::ImageSavingArgs::set_ImageFileName | ( | System::String | value | ) |
void Aspose::Words::Saving::ImageSavingArgs::set_ImageStream | ( | System::SharedPtr< System::IO::Stream > | value | ) |
void Aspose::Words::Saving::ImageSavingArgs::set_KeepImageStreamOpen | ( | bool | value | ) |
|
static |