Aspose::Words::Saving::OoxmlSaveOptions class
Contents
[
Hide
]OoxmlSaveOptions class
Can be used to specify additional options when saving a document into the Docx, Docm, Dotx, Dotm or FlatOpc format. To learn more, visit the Specify Save Options documentation article.
class OoxmlSaveOptions : public Aspose::Words::Saving::SaveOptions
Methods
| Method | Description |
|---|---|
| static CreateSaveOptions(Aspose::Words::SaveFormat) | Creates a save options object of a class suitable for the specified save format. |
| static CreateSaveOptions(const System::String&) | Creates a save options object of a class suitable for the file extension specified in the given file name. |
| 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. |
| get_Compliance() | Specifies the OOXML version for the output document. The default value is Ecma376_2006. |
| get_CompressionLevel() const | Specifies the compression level used to save document. The default value is Normal. |
| get_CustomTimeZoneInfo() const | Gets or sets custom local time zone used for date/time fields. |
| get_DefaultTemplate() const | Gets or sets path to default template (including filename). Default value for this property is empty string. |
| get_DigitalSignatureDetails() const | Gets DigitalSignatureDetails object used to sign a document. |
| get_Dml3DEffectsRenderingMode() const | Gets a value determining how 3D effects are rendered. |
| virtual get_DmlEffectsRenderingMode() | Gets or sets a value determining how DrawingML effects are rendered. |
| get_DmlRenderingMode() const | Gets or sets a value determining how DrawingML shapes are rendered. |
| get_ExportGeneratorName() const | When true, causes the name and version of Aspose.Words to be embedded into produced files. Default value is true. |
| get_ImlRenderingMode() const | Gets or sets a value determining how ink (InkML) objects are rendered. |
| get_KeepLegacyControlChars() const | Keeps original representation of legacy control characters. |
| 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. |
| get_Password() const | Gets/sets a password to encrypt document using ECMA376 Standard encryption algorithm. |
| get_PrettyFormat() const | When true, pretty formats output where applicable. Default value is false. |
| get_ProgressCallback() const | Called during saving a document and accepts data about saving progress. |
| get_SaveFormat() override | Specifies the format in which the document will be saved if this save options object is used. Can be Docx, Docm, Dotx, Dotm or FlatOpc. |
| 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. |
| get_UpdateCreatedTimeProperty() const | Gets a value determining whether the CreatedTime property is updated before saving. Default value is false;. |
| 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. |
| get_UpdateLastPrintedProperty() const | Gets or sets a value determining whether the LastPrinted property is updated before saving. |
| get_UpdateLastSavedTimeProperty() const | Gets or sets a value determining whether the LastSavedTime property is updated before saving. |
| get_UseAntiAliasing() const | Gets or sets a value determining whether or not to use anti-aliasing for rendering. |
| get_UseHighQualityRendering() const | Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms. |
| get_Zip64Mode() const | Specifies whether or not to use ZIP64 format extensions for the output document. The default value is Never. |
| GetType() const override | |
| Is(const System::TypeInfo&) const override | |
| OoxmlSaveOptions() | Initializes a new instance of this class that can be used to save a document in the Docx format. |
| OoxmlSaveOptions(Aspose::Words::SaveFormat) | Initializes a new instance of this class that can be used to save a document in the Docx, Docm, Dotx, Dotm or FlatOpc format. |
| set_AllowEmbeddingPostScriptFonts(bool) | Setter for Aspose::Words::Saving::SaveOptions::get_AllowEmbeddingPostScriptFonts. |
| set_Compliance(Aspose::Words::Saving::OoxmlCompliance) | Setter for Aspose::Words::Saving::OoxmlSaveOptions::get_Compliance. |
| set_CompressionLevel(Aspose::Words::Saving::CompressionLevel) | Setter for Aspose::Words::Saving::OoxmlSaveOptions::get_CompressionLevel. |
| set_CustomTimeZoneInfo(const System::SharedPtr<System::TimeZoneInfo>&) | Setter for Aspose::Words::Saving::SaveOptions::get_CustomTimeZoneInfo. |
| set_DefaultTemplate(const System::String&) | Setter for Aspose::Words::Saving::SaveOptions::get_DefaultTemplate. |
| set_DigitalSignatureDetails(const System::SharedPtr<Aspose::Words::Saving::DigitalSignatureDetails>&) | Sets DigitalSignatureDetails object used to sign a document. |
| set_Dml3DEffectsRenderingMode(Aspose::Words::Saving::Dml3DEffectsRenderingMode) | Sets a value determining how 3D effects are rendered. |
| virtual set_DmlEffectsRenderingMode(Aspose::Words::Saving::DmlEffectsRenderingMode) | Setter for Aspose::Words::Saving::SaveOptions::get_DmlEffectsRenderingMode. |
| set_DmlRenderingMode(Aspose::Words::Saving::DmlRenderingMode) | Setter for Aspose::Words::Saving::SaveOptions::get_DmlRenderingMode. |
| set_ExportGeneratorName(bool) | Setter for Aspose::Words::Saving::SaveOptions::get_ExportGeneratorName. |
| set_ImlRenderingMode(Aspose::Words::Saving::ImlRenderingMode) | Setter for Aspose::Words::Saving::SaveOptions::get_ImlRenderingMode. |
| set_KeepLegacyControlChars(bool) | Setter for Aspose::Words::Saving::OoxmlSaveOptions::get_KeepLegacyControlChars. |
| set_MemoryOptimization(bool) | Setter for Aspose::Words::Saving::SaveOptions::get_MemoryOptimization. |
| set_Password(const System::String&) | Setter for Aspose::Words::Saving::OoxmlSaveOptions::get_Password. |
| set_PrettyFormat(bool) | Setter for Aspose::Words::Saving::SaveOptions::get_PrettyFormat. |
| set_ProgressCallback(const System::SharedPtr<Aspose::Words::Saving::IDocumentSavingCallback>&) | Setter for Aspose::Words::Saving::SaveOptions::get_ProgressCallback. |
| set_SaveFormat(Aspose::Words::SaveFormat) override | Setter for Aspose::Words::Saving::OoxmlSaveOptions::get_SaveFormat. |
| set_TempFolder(const System::String&) | Setter for Aspose::Words::Saving::SaveOptions::get_TempFolder. |
| set_UpdateCreatedTimeProperty(bool) | Sets a value determining whether the CreatedTime property is updated before saving. Default value is false;. |
| set_UpdateFields(bool) | Setter for Aspose::Words::Saving::SaveOptions::get_UpdateFields. |
| set_UpdateLastPrintedProperty(bool) | Setter for Aspose::Words::Saving::SaveOptions::get_UpdateLastPrintedProperty. |
| set_UpdateLastSavedTimeProperty(bool) | Setter for Aspose::Words::Saving::SaveOptions::get_UpdateLastSavedTimeProperty. |
| set_UseAntiAliasing(bool) | Setter for Aspose::Words::Saving::SaveOptions::get_UseAntiAliasing. |
| set_UseHighQualityRendering(bool) | Setter for Aspose::Words::Saving::SaveOptions::get_UseHighQualityRendering. |
| set_Zip64Mode(Aspose::Words::Saving::Zip64Mode) | Setter for Aspose::Words::Saving::OoxmlSaveOptions::get_Zip64Mode. |
| static Type() |
Examples
Shows how to set an OOXML compliance specification for a saved document to adhere to.
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
// If we configure compatibility options to comply with Microsoft Word 2003,
// inserting an image will define its shape using VML.
doc->get_CompatibilityOptions()->OptimizeFor(MsWordVersion::Word2003);
builder->InsertImage(ImageDir + u"Transparent background logo.png");
ASSERT_EQ(ShapeMarkupLanguage::Vml, (System::ExplicitCast<Shape>(doc->GetChild(NodeType::Shape, 0, true)))->get_MarkupLanguage());
// The "ISO/IEC 29500:2008" OOXML standard does not support VML shapes.
// If we set the "Compliance" property of the SaveOptions object to "OoxmlCompliance.Iso29500_2008_Strict",
// any document we save while passing this object will have to follow that standard.
auto saveOptions = MakeObject<OoxmlSaveOptions>();
saveOptions->set_Compliance(OoxmlCompliance::Iso29500_2008_Strict);
saveOptions->set_SaveFormat(SaveFormat::Docx);
doc->Save(ArtifactsDir + u"OoxmlSaveOptions.Iso29500Strict.docx", saveOptions);
// Our saved document defines the shape using DML to adhere to the "ISO/IEC 29500:2008" OOXML standard.
doc = MakeObject<Document>(ArtifactsDir + u"OoxmlSaveOptions.Iso29500Strict.docx");
ASSERT_EQ(ShapeMarkupLanguage::Dml, (System::ExplicitCast<Shape>(doc->GetChild(NodeType::Shape, 0, true)))->get_MarkupLanguage());
See Also
- Class SaveOptions
- Namespace Aspose::Words::Saving
- Library Aspose.Words for C++