Can be used to specify additional options when saving a document into the Odt or Ott format.

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 = MakeObject<Document>(MyDir + u"Rendering.docx");
 
auto saveOptions = MakeObject<OdtSaveOptions>();
saveOptions->set_MeasureUnit(OdtSaveMeasureUnit::Centimeters);
saveOptions->set_IsStrictSchema11(exportToOdt11Specs);
 
doc->Save(ArtifactsDir + u"OdtSaveOptions.Odt11Schema.odt", saveOptions);

Shows how to use different measurement units to define style parameters of a saved ODT document.

auto doc = MakeObject<Document>(MyDir + u"Rendering.docx");
 
// When we export the document to .odt, we can use an OdtSaveOptions object to modify how we save the document.
// We can set the "MeasureUnit" property to "OdtSaveMeasureUnit.Centimeters"
// to define content such as style parameters using the metric system, which Open Office uses.
// We can set the "MeasureUnit" property to "OdtSaveMeasureUnit.Inches"
// to define content such as style parameters using the imperial system, which Microsoft Word uses.
auto saveOptions = MakeObject<OdtSaveOptions>();
saveOptions->set_MeasureUnit(odtSaveMeasureUnit);
 
doc->Save(ArtifactsDir + u"OdtSaveOptions.Odt11Schema.odt", saveOptions);

#include <Aspose.Words.Cpp/Saving/OdtSaveOptions.h>

Inheritance diagram for Aspose::Words::Saving::OdtSaveOptions:

Public Member Functions
	OdtSaveOptions ()
	Initializes a new instance of this class that can be used to save a document in the Odt format. More...

	OdtSaveOptions (SaveFormat saveFormat)
	Initializes a new instance of this class that can be used to save a document in the Odt or Ott format. More...

	OdtSaveOptions (String password)
	Initializes a new instance of this class that can be used to save a document in the Odt format encrypted with a password. More...

bool	get_IsStrictSchema11 () const
	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. More...

OdtSaveMeasureUnit	get_MeasureUnit () const
	Allows to specify units of measure to apply to document content. The default value is Centimeters More...

String	get_Password () const
	Gets or sets a password to encrypt document. More...

SaveFormat	get_SaveFormat () override
	Specifies the format in which the document will be saved if this save options object is used. Can be Odt or Ott. More...

virtual const TypeInfo &	GetType () const override

virtual bool	Is (const TypeInfo &target) const override

void	set_IsStrictSchema11 (bool value)
	Setter for get_IsStrictSchema11. More...

void	set_MeasureUnit (OdtSaveMeasureUnit value)
	Setter for get_MeasureUnit. More...

void	set_Password (String value)
	Setter for get_Password. More...

void	set_SaveFormat (SaveFormat value) override
	Setter for get_SaveFormat. More...

Public Member Functions inherited from SaveOptions
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. 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...

ImlRenderingMode	get_ImlRenderingMode () const
	Gets or sets a value determining how ink (InkML) objects 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...

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
	Gets a value determining whether the CreatedTime property is updated before saving. Default value is false;. More...

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...

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_ImlRenderingMode (ImlRenderingMode value)
	Setter for get_ImlRenderingMode. More...

void	set_MemoryOptimization (bool value)
	Setter for get_MemoryOptimization. More...

void	set_PrettyFormat (bool value)
	Setter for get_PrettyFormat. More...

void	set_TempFolder (String value)
	Setter for get_TempFolder. More...

void	set_UpdateCreatedTimeProperty (bool value)
	Sets a value determining whether the CreatedTime property is updated before saving. Default value is false;. More...

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...

Static Public Member Functions
static const TypeInfo &	Type ()

Static Public Member Functions inherited from SaveOptions
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 ()

Constructor & Destructor Documentation

◆ OdtSaveOptions() [1/3]

Aspose::Words::Saving::OdtSaveOptions::OdtSaveOptions ( )

Initializes a new instance of this class that can be used to save a document in the Odt format.

Examples

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

auto doc = MakeObject<Document>(MyDir + u"Rendering.docx");
 
auto saveOptions = MakeObject<OdtSaveOptions>();
saveOptions->set_MeasureUnit(OdtSaveMeasureUnit::Centimeters);
saveOptions->set_IsStrictSchema11(exportToOdt11Specs);
 
doc->Save(ArtifactsDir + u"OdtSaveOptions.Odt11Schema.odt", saveOptions);

◆ OdtSaveOptions() [2/3]

Aspose::Words::Saving::OdtSaveOptions::OdtSaveOptions ( System::String password )

Initializes a new instance of this class that can be used to save a document in the Odt format encrypted with a password.

◆ OdtSaveOptions() [3/3]

Aspose::Words::Saving::OdtSaveOptions::OdtSaveOptions ( Aspose::Words::SaveFormat saveFormat )

Initializes a new instance of this class that can be used to save a document in the Odt or Ott format.

Parameters

saveFormat Can be Odt or Ott.

Examples

Shows how to encrypt a saved ODT/OTT document with a password, and then load it using Aspose.Words.

auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
builder->Writeln(u"Hello world!");
 
// Create a new OdtSaveOptions, and pass either "SaveFormat.Odt",
// or "SaveFormat.Ott" as the format to save the document in.
auto saveOptions = MakeObject<OdtSaveOptions>(saveFormat);
saveOptions->set_Password(u"@sposeEncrypted_1145");
 
String extensionString = FileFormatUtil::SaveFormatToExtension(saveFormat);
 
// If we open this document with an appropriate editor,
// it will prompt us for the password we specified in the SaveOptions object.
doc->Save(ArtifactsDir + u"OdtSaveOptions.Encrypt" + extensionString, saveOptions);
 
SharedPtr<FileFormatInfo> docInfo = FileFormatUtil::DetectFileFormat(ArtifactsDir + u"OdtSaveOptions.Encrypt" + extensionString);
 
ASSERT_TRUE(docInfo->get_IsEncrypted());
 
// If we wish to open or edit this document again using Aspose.Words,
// we will have to provide a LoadOptions object with the correct password to the loading constructor.
doc = MakeObject<Document>(ArtifactsDir + u"OdtSaveOptions.Encrypt" + extensionString, MakeObject<LoadOptions>(u"@sposeEncrypted_1145"));
 
ASSERT_EQ(u"Hello world!", doc->GetText().Trim());

Member Function Documentation

◆ get_IsStrictSchema11()

bool Aspose::Words::Saving::OdtSaveOptions::get_IsStrictSchema11 ( ) const

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.

Examples

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

auto doc = MakeObject<Document>(MyDir + u"Rendering.docx");
 
auto saveOptions = MakeObject<OdtSaveOptions>();
saveOptions->set_MeasureUnit(OdtSaveMeasureUnit::Centimeters);
saveOptions->set_IsStrictSchema11(exportToOdt11Specs);
 
doc->Save(ArtifactsDir + u"OdtSaveOptions.Odt11Schema.odt", saveOptions);

◆ get_MeasureUnit()

Aspose::Words::Saving::OdtSaveMeasureUnit Aspose::Words::Saving::OdtSaveOptions::get_MeasureUnit ( ) const

Allows to specify units of measure to apply to document content. The default value is Centimeters

Examples

Shows how to use different measurement units to define style parameters of a saved ODT document.

auto doc = MakeObject<Document>(MyDir + u"Rendering.docx");
 
// When we export the document to .odt, we can use an OdtSaveOptions object to modify how we save the document.
// We can set the "MeasureUnit" property to "OdtSaveMeasureUnit.Centimeters"
// to define content such as style parameters using the metric system, which Open Office uses.
// We can set the "MeasureUnit" property to "OdtSaveMeasureUnit.Inches"
// to define content such as style parameters using the imperial system, which Microsoft Word uses.
auto saveOptions = MakeObject<OdtSaveOptions>();
saveOptions->set_MeasureUnit(odtSaveMeasureUnit);
 
doc->Save(ArtifactsDir + u"OdtSaveOptions.Odt11Schema.odt", saveOptions);

◆ get_Password()

System::String Aspose::Words::Saving::OdtSaveOptions::get_Password ( ) const

Gets or sets a password to encrypt document.

In order to save document without encryption this property should be null or empty string.

Examples

Shows how to encrypt a saved ODT/OTT document with a password, and then load it using Aspose.Words.

auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
builder->Writeln(u"Hello world!");
 
// Create a new OdtSaveOptions, and pass either "SaveFormat.Odt",
// or "SaveFormat.Ott" as the format to save the document in.
auto saveOptions = MakeObject<OdtSaveOptions>(saveFormat);
saveOptions->set_Password(u"@sposeEncrypted_1145");
 
String extensionString = FileFormatUtil::SaveFormatToExtension(saveFormat);
 
// If we open this document with an appropriate editor,
// it will prompt us for the password we specified in the SaveOptions object.
doc->Save(ArtifactsDir + u"OdtSaveOptions.Encrypt" + extensionString, saveOptions);
 
SharedPtr<FileFormatInfo> docInfo = FileFormatUtil::DetectFileFormat(ArtifactsDir + u"OdtSaveOptions.Encrypt" + extensionString);
 
ASSERT_TRUE(docInfo->get_IsEncrypted());
 
// If we wish to open or edit this document again using Aspose.Words,
// we will have to provide a LoadOptions object with the correct password to the loading constructor.
doc = MakeObject<Document>(ArtifactsDir + u"OdtSaveOptions.Encrypt" + extensionString, MakeObject<LoadOptions>(u"@sposeEncrypted_1145"));
 
ASSERT_EQ(u"Hello world!", doc->GetText().Trim());

◆ get_SaveFormat()

Aspose::Words::SaveFormat Aspose::Words::Saving::OdtSaveOptions::get_SaveFormat ( )

overridevirtual

Specifies the format in which the document will be saved if this save options object is used. Can be Odt or Ott.

Examples

Shows how to encrypt a saved ODT/OTT document with a password, and then load it using Aspose.Words.

auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
builder->Writeln(u"Hello world!");
 
// Create a new OdtSaveOptions, and pass either "SaveFormat.Odt",
// or "SaveFormat.Ott" as the format to save the document in.
auto saveOptions = MakeObject<OdtSaveOptions>(saveFormat);
saveOptions->set_Password(u"@sposeEncrypted_1145");
 
String extensionString = FileFormatUtil::SaveFormatToExtension(saveFormat);
 
// If we open this document with an appropriate editor,
// it will prompt us for the password we specified in the SaveOptions object.
doc->Save(ArtifactsDir + u"OdtSaveOptions.Encrypt" + extensionString, saveOptions);
 
SharedPtr<FileFormatInfo> docInfo = FileFormatUtil::DetectFileFormat(ArtifactsDir + u"OdtSaveOptions.Encrypt" + extensionString);
 
ASSERT_TRUE(docInfo->get_IsEncrypted());
 
// If we wish to open or edit this document again using Aspose.Words,
// we will have to provide a LoadOptions object with the correct password to the loading constructor.
doc = MakeObject<Document>(ArtifactsDir + u"OdtSaveOptions.Encrypt" + extensionString, MakeObject<LoadOptions>(u"@sposeEncrypted_1145"));
 
ASSERT_EQ(u"Hello world!", doc->GetText().Trim());