This is an abstract base class for classes that allow the user to specify additional options when saving a document into a particular format.
Shows how to specify saving options while converting a document to .epub.
#include <Aspose.Words.Cpp/Model/Saving/SaveOptions.h>
Public Member Functions | |
bool | get_AllowEmbeddingPostScriptFonts () const |
Gets or sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. The default value is false. More... | |
SharedPtr< TimeZoneInfo > | get_CustomTimeZoneInfo () const |
String | get_DefaultTemplate () const |
Gets or sets path to default template (including filename). Default value for this property is empty string (Empty). More... | |
Dml3DEffectsRenderingMode | get_Dml3DEffectsRenderingMode () const |
Gets a value determining how 3D effects are rendered. More... | |
virtual DmlEffectsRenderingMode | get_DmlEffectsRenderingMode () |
Gets or sets a value determining how DrawingML effects are rendered. More... | |
DmlRenderingMode | get_DmlRenderingMode () const |
Gets or sets a value determining how DrawingML shapes are rendered. More... | |
bool | get_MemoryOptimization () const |
Gets or sets value determining if memory optimization should be performed before saving the document. Default value for this property is false. More... | |
bool | get_PrettyFormat () const |
When true , pretty formats output where applicable. Default value is false. More... | |
virtual SaveFormat | get_SaveFormat ()=0 |
Specifies the format in which the document will be saved if this save options object is used. More... | |
String | get_TempFolder () const |
Specifies the folder for temporary files used when saving to a DOC or DOCX file. By default this property is null and no temporary files are used. More... | |
bool | get_UpdateCreatedTimeProperty () const |
bool | get_UpdateFields () const |
Gets or sets a value determining if fields of certain types should be updated before saving the document to a fixed page format. Default value for this property is true. More... | |
bool | get_UpdateLastPrintedProperty () const |
Gets or sets a value determining whether the LastPrinted property is updated before saving. More... | |
bool | get_UpdateLastSavedTimeProperty () const |
Gets or sets a value determining whether the LastSavedTime property is updated before saving. More... | |
bool | get_UpdateSdtContent () const |
Gets or sets value determining whether content of StructuredDocumentTag is updated before saving. More... | |
bool | get_UseAntiAliasing () const |
Gets or sets a value determining whether or not to use anti-aliasing for rendering. More... | |
bool | get_UseHighQualityRendering () const |
Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms. More... | |
virtual const TypeInfo & | GetType () const override |
virtual bool | Is (const TypeInfo &target) const override |
void | set_AllowEmbeddingPostScriptFonts (bool value) |
Setter for get_AllowEmbeddingPostScriptFonts. More... | |
void | set_CustomTimeZoneInfo (SharedPtr< TimeZoneInfo > value) |
void | set_DefaultTemplate (String value) |
Setter for get_DefaultTemplate. More... | |
void | set_Dml3DEffectsRenderingMode (Dml3DEffectsRenderingMode value) |
Sets a value determining how 3D effects are rendered. More... | |
virtual void | set_DmlEffectsRenderingMode (DmlEffectsRenderingMode value) |
Setter for get_DmlEffectsRenderingMode. More... | |
void | set_DmlRenderingMode (DmlRenderingMode value) |
Setter for get_DmlRenderingMode. More... | |
void | set_MemoryOptimization (bool value) |
Setter for get_MemoryOptimization. More... | |
void | set_PrettyFormat (bool value) |
Setter for get_PrettyFormat. More... | |
virtual void | set_SaveFormat (SaveFormat value)=0 |
Setter for get_SaveFormat. More... | |
void | set_TempFolder (String value) |
Setter for get_TempFolder. More... | |
void | set_UpdateCreatedTimeProperty (bool value) |
void | set_UpdateFields (bool value) |
Setter for get_UpdateFields. More... | |
void | set_UpdateLastPrintedProperty (bool value) |
Setter for get_UpdateLastPrintedProperty. More... | |
void | set_UpdateLastSavedTimeProperty (bool value) |
Setter for get_UpdateLastSavedTimeProperty. More... | |
void | set_UpdateSdtContent (bool value) |
Setter for get_UpdateSdtContent. More... | |
void | set_UseAntiAliasing (bool value) |
Setter for get_UseAntiAliasing. More... | |
void | set_UseHighQualityRendering (bool value) |
Setter for get_UseHighQualityRendering. More... | |
![]() | |
Object () | |
Object (Object const &x) | |
virtual | ~Object () |
virtual bool | Equals (ptr obj) |
virtual bool | FastCast (const Details::FastRttiBase &helper, void **out_ptr) const |
Detail::SmartPtrCounter * | GetCounter () |
virtual int32_t | GetHashCode () const |
void | Lock () |
virtual ptr | MemberwiseClone () const |
Object & | operator= (Object const &x) |
bool | ReferenceEquals (String const &str, std::nullptr_t) |
bool | ReferenceEquals (String const &str1, String const &str2) |
int | RemovedSharedRefs (int count) |
virtual void | SetTemplateWeakPtr (unsigned int argument) |
int | SharedCount () const |
Object * | SharedRefAdded () |
int | SharedRefRemovedSafe () |
virtual String | ToString () const |
void | Unlock () |
Detail::SmartPtrCounter * | WeakRefAdded () |
void | WeakRefRemoved () |
Static Public Member Functions | |
static SharedPtr< SaveOptions > | CreateSaveOptions (SaveFormat saveFormat) |
Creates a save options object of a class suitable for the specified save format. More... | |
static SharedPtr< SaveOptions > | CreateSaveOptions (String fileName) |
Creates a save options object of a class suitable for the file extension specified in the given file name. More... | |
static const TypeInfo & | Type () |
![]() | |
bool | Equals (double const &objA, double const &objB) |
bool | Equals (float const &objA, float const &objB) |
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type | Equals (T1 const &objA, T2 const &objB) |
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type | Equals (T1 const &objA, T2 const &objB) |
static bool | ReferenceEquals (ptr const &objA, ptr const &objB) |
static std::enable_if<!IsSmartPtr< T >::value, bool >::type | ReferenceEquals (T const &objA, std::nullptr_t) |
static std::enable_if<!IsSmartPtr< T >::value, bool >::type | ReferenceEquals (T const &objA, T const &objB) |
static const TypeInfo & | Type () |
Additional Inherited Members | |
![]() | |
typedef SmartPtr< Object > | ptr |
typedef System::Details::SharedMembersType | shared_members_type |
|
static |
Creates a save options object of a class suitable for the specified save format.
saveFormat | The save format for which to create a save options object. |
Shows an option to optimize memory consumption when you work with large documents.
|
static |
Creates a save options object of a class suitable for the file extension specified in the given file name.
fileName | The extension of this file name determines the class of the save options object to create. |
Shows how to set a default template for documents that do not have attached templates.
bool Aspose::Words::Saving::SaveOptions::get_AllowEmbeddingPostScriptFonts | ( | ) | const |
Gets or sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. The default value is false.
Note, Word does not embed PostScript fonts, but can open documents with embedded fonts of this type.
This option only works when EmbedTrueTypeFonts of the FontInfos property is set to true
.
System::SharedPtr<System::TimeZoneInfo> Aspose::Words::Saving::SaveOptions::get_CustomTimeZoneInfo | ( | ) | const |
System::String Aspose::Words::Saving::SaveOptions::get_DefaultTemplate | ( | ) | const |
Gets or sets path to default template (including filename). Default value for this property is empty string (Empty).
Shows how to set a default template for documents that do not have attached templates.
Aspose::Words::Saving::Dml3DEffectsRenderingMode Aspose::Words::Saving::SaveOptions::get_Dml3DEffectsRenderingMode | ( | ) | const |
Gets a value determining how 3D effects are rendered.
|
virtual |
Gets or sets a value determining how DrawingML effects are rendered.
The default value is Simplified.
This property is used when the document is exported to fixed page formats.
Shows how to configure DrawingML rendering quality with PdfSaveOptions.
Reimplemented in Aspose::Words::Saving::PdfSaveOptions.
Aspose::Words::Saving::DmlRenderingMode Aspose::Words::Saving::SaveOptions::get_DmlRenderingMode | ( | ) | const |
Gets or sets a value determining how DrawingML shapes are rendered.
The default value is Fallback.
This property is used when the document is exported to fixed page formats.
Shows how to configure DrawingML rendering quality with PdfSaveOptions.
Shows how to render fallback shapes when saving to Pdf.
bool Aspose::Words::Saving::SaveOptions::get_MemoryOptimization | ( | ) | const |
Gets or sets value determining if memory optimization should be performed before saving the document. Default value for this property is false.
Shows an option to optimize memory consumption when you work with large documents.
bool Aspose::Words::Saving::SaveOptions::get_PrettyFormat | ( | ) | const |
When true
, pretty formats output where applicable. Default value is false.
Set to true to make HTML, MHTML, EPUB, WordML, RTF, DOCX and ODT output human readable. Useful for testing or debugging.
Shows how to enhance the readability of the raw code of a saved .html document.
|
pure virtual |
Specifies the format in which the document will be saved if this save options object is used.
Shows how to specify saving options while converting a document to .epub.
Implemented in Aspose::Words::Saving::XpsSaveOptions, Aspose::Words::Saving::XamlFlowSaveOptions, Aspose::Words::Saving::XamlFixedSaveOptions, Aspose::Words::Saving::WordML2003SaveOptions, Aspose::Words::Saving::TxtSaveOptions, Aspose::Words::Saving::SvgSaveOptions, Aspose::Words::Saving::RtfSaveOptions, Aspose::Words::Saving::PsSaveOptions, Aspose::Words::Saving::PdfSaveOptions, Aspose::Words::Saving::PclSaveOptions, Aspose::Words::Saving::OoxmlSaveOptions, Aspose::Words::Saving::OdtSaveOptions, Aspose::Words::Saving::MarkdownSaveOptions, Aspose::Words::Saving::ImageSaveOptions, Aspose::Words::Saving::HtmlSaveOptions, Aspose::Words::Saving::HtmlFixedSaveOptions, and Aspose::Words::Saving::DocSaveOptions.
System::String Aspose::Words::Saving::SaveOptions::get_TempFolder | ( | ) | const |
Specifies the folder for temporary files used when saving to a DOC or DOCX file. By default this property is null
and no temporary files are used.
When Aspose.Words saves a document, it needs to create temporary internal structures. By default, these internal structures are created in memory and the memory usage spikes for a short period while the document is being saved. When saving is complete, the memory is freed and reclaimed by the garbage collector.
If you are saving a very large document (thousands of pages) and/or processing many documents at the same time, then the memory spike during saving can be significant enough to cause the system to throw OutOfMemoryException. Specifying a temporary folder using TempFolder will cause Aspose.Words to keep the internal structures in temporary files instead of memory. It reduces the memory usage during saving, but will decrease the save performance.
The folder must exist and be writable, otherwise an exception will be thrown.
Aspose.Words automatically deletes all temporary files when saving is complete.
Shows how to use the hard drive instead of memory when saving a document.
bool Aspose::Words::Saving::SaveOptions::get_UpdateCreatedTimeProperty | ( | ) | const |
bool Aspose::Words::Saving::SaveOptions::get_UpdateFields | ( | ) | const |
Gets or sets a value determining if fields of certain types should be updated before saving the document to a fixed page format. Default value for this property is true.
Shows how to update fields before saving into a PDF document.
bool Aspose::Words::Saving::SaveOptions::get_UpdateLastPrintedProperty | ( | ) | const |
Gets or sets a value determining whether the LastPrinted property is updated before saving.
Shows how to update a document's "Last printed" property when saving.
bool Aspose::Words::Saving::SaveOptions::get_UpdateLastSavedTimeProperty | ( | ) | const |
Gets or sets a value determining whether the LastSavedTime property is updated before saving.
Shows how to update a document time property when you want to save it.
bool Aspose::Words::Saving::SaveOptions::get_UpdateSdtContent | ( | ) | const |
Gets or sets value determining whether content of StructuredDocumentTag is updated before saving.
Shows how structured document tags can be updated while saving to .pdf.
bool Aspose::Words::Saving::SaveOptions::get_UseAntiAliasing | ( | ) | const |
Gets or sets a value determining whether or not to use anti-aliasing for rendering.
The default value is false
. When this value is set to true
anti-aliasing is used for rendering.
This property is used when the document is exported to the following formats: Tiff, Png, Bmp, Jpeg, Emf. When the document is exported to the Html, Mhtml and Epub formats this option is used for raster images.
Shows how to improve the quality of a rendered document with SaveOptions.
bool Aspose::Words::Saving::SaveOptions::get_UseHighQualityRendering | ( | ) | const |
Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms.
The default value is false
.
This property is used when the document is exported to image formats: Tiff, Png, Bmp, Jpeg, Emf.
Shows how to improve the quality of a rendered document with SaveOptions.
|
overridevirtual |
Reimplemented from System::Object.
Reimplemented in Aspose::Words::Saving::XpsSaveOptions, Aspose::Words::Saving::XamlFlowSaveOptions, Aspose::Words::Saving::XamlFixedSaveOptions, Aspose::Words::Saving::WordML2003SaveOptions, Aspose::Words::Saving::TxtSaveOptionsBase, Aspose::Words::Saving::TxtSaveOptions, Aspose::Words::Saving::SvgSaveOptions, Aspose::Words::Saving::RtfSaveOptions, Aspose::Words::Saving::PsSaveOptions, Aspose::Words::Saving::PdfSaveOptions, Aspose::Words::Saving::PclSaveOptions, Aspose::Words::Saving::OoxmlSaveOptions, Aspose::Words::Saving::OdtSaveOptions, Aspose::Words::Saving::MarkdownSaveOptions, Aspose::Words::Saving::ImageSaveOptions, Aspose::Words::Saving::HtmlSaveOptions, Aspose::Words::Saving::HtmlFixedSaveOptions, Aspose::Words::Saving::FixedPageSaveOptions, and Aspose::Words::Saving::DocSaveOptions.
|
overridevirtual |
Reimplemented from System::Object.
Reimplemented in Aspose::Words::Saving::XpsSaveOptions, Aspose::Words::Saving::XamlFlowSaveOptions, Aspose::Words::Saving::XamlFixedSaveOptions, Aspose::Words::Saving::WordML2003SaveOptions, Aspose::Words::Saving::TxtSaveOptionsBase, Aspose::Words::Saving::TxtSaveOptions, Aspose::Words::Saving::SvgSaveOptions, Aspose::Words::Saving::RtfSaveOptions, Aspose::Words::Saving::PsSaveOptions, Aspose::Words::Saving::PdfSaveOptions, Aspose::Words::Saving::PclSaveOptions, Aspose::Words::Saving::OoxmlSaveOptions, Aspose::Words::Saving::OdtSaveOptions, Aspose::Words::Saving::MarkdownSaveOptions, Aspose::Words::Saving::ImageSaveOptions, Aspose::Words::Saving::HtmlSaveOptions, Aspose::Words::Saving::HtmlFixedSaveOptions, Aspose::Words::Saving::FixedPageSaveOptions, and Aspose::Words::Saving::DocSaveOptions.
void Aspose::Words::Saving::SaveOptions::set_AllowEmbeddingPostScriptFonts | ( | bool | value | ) |
void Aspose::Words::Saving::SaveOptions::set_CustomTimeZoneInfo | ( | System::SharedPtr< System::TimeZoneInfo > | value | ) |
void Aspose::Words::Saving::SaveOptions::set_DefaultTemplate | ( | System::String | value | ) |
void Aspose::Words::Saving::SaveOptions::set_Dml3DEffectsRenderingMode | ( | Aspose::Words::Saving::Dml3DEffectsRenderingMode | value | ) |
Sets a value determining how 3D effects are rendered.
|
virtual |
Setter for Aspose::Words::Saving::SaveOptions::get_DmlEffectsRenderingMode.
Reimplemented in Aspose::Words::Saving::PdfSaveOptions.
void Aspose::Words::Saving::SaveOptions::set_DmlRenderingMode | ( | Aspose::Words::Saving::DmlRenderingMode | value | ) |
void Aspose::Words::Saving::SaveOptions::set_MemoryOptimization | ( | bool | value | ) |
void Aspose::Words::Saving::SaveOptions::set_PrettyFormat | ( | bool | value | ) |
|
pure virtual |
Setter for Aspose::Words::Saving::SaveOptions::get_SaveFormat.
Implemented in Aspose::Words::Saving::XpsSaveOptions, Aspose::Words::Saving::XamlFlowSaveOptions, Aspose::Words::Saving::XamlFixedSaveOptions, Aspose::Words::Saving::WordML2003SaveOptions, Aspose::Words::Saving::TxtSaveOptions, Aspose::Words::Saving::SvgSaveOptions, Aspose::Words::Saving::RtfSaveOptions, Aspose::Words::Saving::PsSaveOptions, Aspose::Words::Saving::PdfSaveOptions, Aspose::Words::Saving::PclSaveOptions, Aspose::Words::Saving::OoxmlSaveOptions, Aspose::Words::Saving::OdtSaveOptions, Aspose::Words::Saving::MarkdownSaveOptions, Aspose::Words::Saving::ImageSaveOptions, Aspose::Words::Saving::HtmlSaveOptions, Aspose::Words::Saving::HtmlFixedSaveOptions, and Aspose::Words::Saving::DocSaveOptions.
void Aspose::Words::Saving::SaveOptions::set_TempFolder | ( | System::String | value | ) |
void Aspose::Words::Saving::SaveOptions::set_UpdateCreatedTimeProperty | ( | bool | value | ) |
void Aspose::Words::Saving::SaveOptions::set_UpdateFields | ( | bool | value | ) |
void Aspose::Words::Saving::SaveOptions::set_UpdateLastPrintedProperty | ( | bool | value | ) |
void Aspose::Words::Saving::SaveOptions::set_UpdateLastSavedTimeProperty | ( | bool | value | ) |
void Aspose::Words::Saving::SaveOptions::set_UpdateSdtContent | ( | bool | value | ) |
void Aspose::Words::Saving::SaveOptions::set_UseAntiAliasing | ( | bool | value | ) |
void Aspose::Words::Saving::SaveOptions::set_UseHighQualityRendering | ( | bool | value | ) |
|
static |