Aspose::Words::Saving::ImageSavingArgs class
Contents
[
Hide
]ImageSavingArgs class
Provides data for the ImageSaving() event. To learn more, visit the Save a Document documentation article.
class ImageSavingArgs : public System::Object
Methods
| Method | Description |
|---|---|
| get_CurrentShape() const | Gets the ShapeBase object corresponding to the shape or group shape that is about to be saved. |
| get_Document() | Gets the document object that is currently being saved. |
| get_ImageFileName() const | Gets or sets the file name (without path) where the image will be saved to. |
| get_ImageStream() const | Allows to specify the stream where the image will be saved to. |
| get_IsImageAvailable() const | Returns true if the current image is available for export. |
| get_KeepImageStreamOpen() const | Specifies whether Aspose.Words should keep the stream open or close it after saving an image. |
| GetType() const override | |
| Is(const System::TypeInfo&) const override | |
| set_ImageFileName(const System::String&) | Setter for Aspose::Words::Saving::ImageSavingArgs::get_ImageFileName. |
| set_ImageStream(const System::SharedPtr<System::IO::Stream>&) | Setter for Aspose::Words::Saving::ImageSavingArgs::get_ImageStream. |
| set_ImageStream(std::basic_ostream<CharType, Traits>&) | |
| set_KeepImageStreamOpen(bool) | Setter for Aspose::Words::Saving::ImageSavingArgs::get_KeepImageStreamOpen. |
| static Type() |
Remarks
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.
See Also
- Namespace Aspose::Words::Saving
- Library Aspose.Words for C++