Aspose::Words::Saving::OdtSaveOptions Class Reference

Can be used to specify additional options when saving a document into the Aspose::Words::SaveFormat::Odt or Aspose::Words::SaveFormat::Ott format. More...

#include "Model/Saving/OdtSaveOptions.h"

Inherits Aspose::Words::Saving::SaveOptions.

Public Member Functions

virtual Aspose::Words::SaveFormat get_SaveFormat ()
 Specifies the format in which the document will be saved if this save options object is used. Can be Aspose::Words::SaveFormat::Odt or Aspose::Words::SaveFormat::Ott. More...
 
virtual void set_SaveFormat (Aspose::Words::SaveFormat value)
 Setter for Aspose::Words::Saving::OdtSaveOptions::get_SaveFormat. 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...
 
void set_IsStrictSchema11 (bool value)
 Setter for Aspose::Words::Saving::OdtSaveOptions::get_IsStrictSchema11. More...
 
Aspose::Words::Saving::OdtSaveMeasureUnit get_MeasureUnit () const
 Allows to specify units of measure to apply to document content. The default value is Aspose::Words::Saving::OdtSaveMeasureUnit::Centimeters More...
 
void set_MeasureUnit (Aspose::Words::Saving::OdtSaveMeasureUnit value)
 Setter for Aspose::Words::Saving::OdtSaveOptions::get_MeasureUnit. More...
 
System::String get_Password () const
 Gets or sets a password to encrypt document. More...
 
void set_Password (System::String value)
 Setter for Aspose::Words::Saving::OdtSaveOptions::get_Password. More...
 
 OdtSaveOptions ()
 Initializes a new instance of this class that can be used to save a document in the Aspose::Words::SaveFormat::Odt format. More...
 
 OdtSaveOptions (System::String password)
 Initializes a new instance of this class that can be used to save a document in the Aspose::Words::SaveFormat::Odt format encrypted with a password. More...
 
 OdtSaveOptions (Aspose::Words::SaveFormat saveFormat)
 Initializes a new instance of this class that can be used to save a document in the Aspose::Words::SaveFormat::Odt or Aspose::Words::SaveFormat::Ott format. More...
 
- Public Member Functions inherited from Aspose::Words::Saving::SaveOptions
System::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...
 
void set_TempFolder (System::String value)
 Setter for Aspose::Words::Saving::SaveOptions::get_TempFolder. More...
 
bool get_PrettyFormat () const
 When true, pretty formats output where applicable. Default value is false. More...
 
void set_PrettyFormat (bool value)
 Setter for Aspose::Words::Saving::SaveOptions::get_PrettyFormat. More...
 
bool get_UseAntiAliasing () const
 Gets or sets a value determining whether or not to use anti-aliasing for rendering. More...
 
void set_UseAntiAliasing (bool value)
 Setter for Aspose::Words::Saving::SaveOptions::get_UseAntiAliasing. 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_UseHighQualityRendering (bool value)
 Setter for Aspose::Words::Saving::SaveOptions::get_UseHighQualityRendering. More...
 
bool get_UpdateSdtContent () const
 Gets or sets value determining whether content of Aspose::Words::Markup::StructuredDocumentTag is updated before saving. More...
 
void set_UpdateSdtContent (bool value)
 Setter for Aspose::Words::Saving::SaveOptions::get_UpdateSdtContent. More...
 
Aspose::Words::Saving::ColorMode get_ColorMode () const
 Gets or sets a value determining how colors are rendered. More...
 
void set_ColorMode (Aspose::Words::Saving::ColorMode value)
 Setter for Aspose::Words::Saving::SaveOptions::get_ColorMode. More...
 
Aspose::Words::Saving::DmlRenderingMode get_DmlRenderingMode () const
 Gets or sets a value determining how DrawingML shapes are rendered. More...
 
void set_DmlRenderingMode (Aspose::Words::Saving::DmlRenderingMode value)
 Setter for Aspose::Words::Saving::SaveOptions::get_DmlRenderingMode. More...
 
virtual Aspose::Words::Saving::DmlEffectsRenderingMode get_DmlEffectsRenderingMode ()
 Gets or sets a value determining how DrawingML effects are rendered. More...
 
virtual void set_DmlEffectsRenderingMode (Aspose::Words::Saving::DmlEffectsRenderingMode value)
 Setter for Aspose::Words::Saving::SaveOptions::get_DmlEffectsRenderingMode. More...
 
System::String get_DefaultTemplate () const
 Gets or sets path to default template (including filename). Default value for this property is empty string (System::String::Empty). More...
 
void set_DefaultTemplate (System::String value)
 Setter for Aspose::Words::Saving::SaveOptions::get_DefaultTemplate. 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...
 
void set_UpdateFields (bool value)
 Setter for Aspose::Words::Saving::SaveOptions::get_UpdateFields. More...
 
bool get_UpdateLastSavedTimeProperty () const
 Gets or sets a value determining whether the Aspose::Words::Properties::BuiltInDocumentProperties::get_LastSavedTime property is updated before saving. More...
 
void set_UpdateLastSavedTimeProperty (bool value)
 Setter for Aspose::Words::Saving::SaveOptions::get_UpdateLastSavedTimeProperty. 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...
 
void set_MemoryOptimization (bool value)
 Setter for Aspose::Words::Saving::SaveOptions::get_MemoryOptimization. More...
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared refernce counter. More...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () ASPOSE_CONST
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual void SetTemplateWeakPtr (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. More...
 
- Static Public Member Functions inherited from Aspose::Words::Saving::SaveOptions
static System::SharedPtr< Aspose::Words::Saving::SaveOptionsCreateSaveOptions (Aspose::Words::SaveFormat saveFormat)
 Creates a save options object of a class suitable for the specified save format. More...
 
static System::SharedPtr< Aspose::Words::Saving::SaveOptionsCreateSaveOptions (System::String fileName)
 Creates a save options object of a class suitable for the file extension specified in the given file name. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Impleemnts C# typeof(System.Object) construct. More...
 

Detailed Description

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

At the moment provides only the Aspose::Words::Saving::OdtSaveOptions::get_SaveFormat property, but in the future will have other options added, such as an encryption password or digital signature settings.

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 Aspose::Words::SaveFormat::Odt format.

◆ 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 Aspose::Words::SaveFormat::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 Aspose::Words::SaveFormat::Odt or Aspose::Words::SaveFormat::Ott format.

Parameters
saveFormatCan be Aspose::Words::SaveFormat::Odt or Aspose::Words::SaveFormat::Ott.

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.

◆ 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 Aspose::Words::Saving::OdtSaveMeasureUnit::Centimeters

Open Office uses centimeters when specifying lengths, widths and other measurable formatting and content properties in documents whereas MS Office uses inches.

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

◆ get_SaveFormat()

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

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

Implements Aspose::Words::Saving::SaveOptions.

◆ set_IsStrictSchema11()

void Aspose::Words::Saving::OdtSaveOptions::set_IsStrictSchema11 ( bool  value)

◆ set_MeasureUnit()

void Aspose::Words::Saving::OdtSaveOptions::set_MeasureUnit ( Aspose::Words::Saving::OdtSaveMeasureUnit  value)

◆ set_Password()

void Aspose::Words::Saving::OdtSaveOptions::set_Password ( System::String  value)

◆ set_SaveFormat()

virtual void Aspose::Words::Saving::OdtSaveOptions::set_SaveFormat ( Aspose::Words::SaveFormat  value)
virtual