Aspose::Words::Saving::OdtSaveOptions class

OdtSaveOptions class

Can be used to specify additional options when saving a document into the Odt or Ott format. To learn more, visit the Specify Save Options documentation article.

class OdtSaveOptions : public SaveOptions

Methods

MethodDescription
OdtSaveOptions()Initializes a new instance of this class that can be used to save a document in the Odt format.
OdtSaveOptions(Aspose::Words::SaveFormat)Initializes a new instance of this class that can be used to save a document in the Odt or Ott format.
OdtSaveOptions(const System::String &)Initializes a new instance of this class that can be used to save a document in the Odt format encrypted with a password.
get_DigitalSignatureDetails() constGets DigitalSignatureDetails object used to sign a document.
get_IsStrictSchema11() constSpecifies whether export should correspond to ODT specification 1.1 strictly. OOo 3.0 displays files correctly when they contain elements and attributes of ODT 1.2. Use “false” for this purpose, or “true” for strict conformity of specification 1.1. The default value is false.
get_MeasureUnit() constAllows to specify units of measure to apply to document content. The default value is Centimeters
get_Password() constGets or sets a password to encrypt document.
get_SaveFormat() overrideSpecifies the format in which the document will be saved if this save options object is used. Can be Odt or Ott.
set_DigitalSignatureDetails(const System::SharedPtr<Aspose::Words::Saving::DigitalSignatureDetails> &)Sets DigitalSignatureDetails object used to sign a document.
set_IsStrictSchema11(bool)Specifies whether export should correspond to ODT specification 1.1 strictly. OOo 3.0 displays files correctly when they contain elements and attributes of ODT 1.2. Use “false” for this purpose, or “true” for strict conformity of specification 1.1. The default value is false.
set_MeasureUnit(Aspose::Words::Saving::OdtSaveMeasureUnit)Allows to specify units of measure to apply to document content. The default value is Centimeters
set_Password(const System::String &)Sets a password to encrypt document.
set_SaveFormat(Aspose::Words::SaveFormat) overrideSpecifies the format in which the document will be saved if this save options object is used. Can be Odt or Ott.
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() constGets 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_CustomTimeZoneInfo() constGets or sets custom local time zone used for date/time fields.
get_DefaultTemplate() constGets or sets path to default template (including filename). Default value for this property is empty string.
get_Dml3DEffectsRenderingMode() constGets or sets a value determining how 3D effects are rendered.
virtual get_DmlEffectsRenderingMode()Gets or sets a value determining how DrawingML effects are rendered.
get_DmlRenderingMode() constGets or sets a value determining how DrawingML shapes are rendered.
get_ExportGeneratorName() constWhen true, causes the name and version of Aspose.Words to be embedded into produced files. Default value is true.
get_ImlRenderingMode() constGets or sets a value determining how ink (InkML) objects are rendered.
get_MemoryOptimization() constGets or sets value determining if memory optimization should be performed before saving the document. Default value for this property is false.
get_PrettyFormat() constWhen true, pretty formats output where applicable. Default value is false.
get_ProgressCallback() constCalled during saving a document and accepts data about saving progress.
virtual get_SaveFormat()Specifies the format in which the document will be saved if this save options object is used.
get_TempFolder() constSpecifies 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_UpdateAmbiguousTextFont() constDetermines whether the font attributes will be changed according to the character code being used.
get_UpdateCreatedTimeProperty() constGets or sets a value determining whether the CreatedTime property is updated before saving. Default value is false;
get_UpdateFields() constGets 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() constGets or sets a value determining whether the LastPrinted property is updated before saving.
get_UpdateLastSavedTimeProperty() constGets or sets a value determining whether the LastSavedTime property is updated before saving.
get_UpdateOleControlImages() constGets a value determining whether OLE controls presentation image will be updated.
get_UseAntiAliasing() constGets or sets a value determining whether or not to use anti-aliasing for rendering.
get_UseHighQualityRendering() constGets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms.
set_AllowEmbeddingPostScriptFonts(bool)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.
set_CustomTimeZoneInfo(const System::SharedPtr<System::TimeZoneInfo> &)Sets custom local time zone used for date/time fields.
set_DefaultTemplate(const System::String &)Sets path to default template (including filename). Default value for this property is empty string.
set_Dml3DEffectsRenderingMode(Aspose::Words::Saving::Dml3DEffectsRenderingMode)Sets a value determining how 3D effects are rendered.
virtual set_DmlEffectsRenderingMode(Aspose::Words::Saving::DmlEffectsRenderingMode)Sets a value determining how DrawingML effects are rendered.
set_DmlRenderingMode(Aspose::Words::Saving::DmlRenderingMode)Sets a value determining how DrawingML shapes are rendered.
set_ExportGeneratorName(bool)When true, causes the name and version of Aspose.Words to be embedded into produced files. Default value is true.
set_ImlRenderingMode(Aspose::Words::Saving::ImlRenderingMode)Sets a value determining how ink (InkML) objects are rendered.
set_MemoryOptimization(bool)Sets value determining if memory optimization should be performed before saving the document. Default value for this property is false.
set_PrettyFormat(bool)When true, pretty formats output where applicable. Default value is false.
set_ProgressCallback(const System::SharedPtr<Aspose::Words::Saving::IDocumentSavingCallback> &)Called during saving a document and accepts data about saving progress.
virtual set_SaveFormat(Aspose::Words::SaveFormat)Specifies the format in which the document will be saved if this save options object is used.
set_TempFolder(const System::String &)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.
set_UpdateAmbiguousTextFont(bool)Determines whether the font attributes will be changed according to the character code being used.
set_UpdateCreatedTimeProperty(bool)Sets a value determining whether the CreatedTime property is updated before saving. Default value is false;
set_UpdateFields(bool)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.
set_UpdateLastPrintedProperty(bool)Sets a value determining whether the LastPrinted property is updated before saving.
set_UpdateLastSavedTimeProperty(bool)Sets a value determining whether the LastSavedTime property is updated before saving.
set_UpdateOleControlImages(bool)Sets a value determining whether OLE controls presentation image will be updated.
set_UseAntiAliasing(bool)Sets a value determining whether or not to use anti-aliasing for rendering.
set_UseHighQualityRendering(bool)Sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms.

Remarks

At the moment provides only the SaveFormat property, but in the future will have other options added, such as an encryption password or digital signature settings.

Examples

Shows how to make a saved document conform to an older ODT schema.

auto doc = System::MakeObject<Aspose::Words::Document>(System::String(get_MyDir() + u"Rendering.docx"));

auto saveOptions = System::MakeObject<Aspose::Words::Saving::OdtSaveOptions>();
saveOptions->set_MeasureUnit(OdtSaveMeasureUnit::Centimeters);
saveOptions->set_IsStrictSchema11(exportToOdt11Specs);

doc->Save(get_ArtifactsDir() + u"OdtSaveOptions.Odt11Schema.odt", saveOptions);

doc = System::MakeObject<Aspose::Words::Document>(System::String(get_ArtifactsDir() + u"OdtSaveOptions.Odt11Schema.odt"));
ASSERT_EQ(doc->get_LayoutOptions()->get_RevisionOptions()->get_MeasurementUnit(), Aspose::Words::MeasurementUnits::Centimeters);

See Also