com.aspose.words

Class OdtSaveOptions

java.lang.Object

com.aspose.words.SaveOptions

com.aspose.words.OdtSaveOptions

public class OdtSaveOptions
extends SaveOptions

Can be used to specify additional options when saving a document into the SaveFormat.ODT or SaveFormat.OTT format.

To learn more, visit the Specify Save Options documentation article.

Remarks:

At the moment provides only the getSaveFormat() / setSaveFormat(int) 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.

 
 Document doc = new Document(getMyDir() + "Rendering.docx");

 OdtSaveOptions saveOptions = new OdtSaveOptions();
 {
     saveOptions.setMeasureUnit(OdtSaveMeasureUnit.CENTIMETERS);
     saveOptions.isStrictSchema11(exportToOdt11Specs);
 }

 doc.save(getArtifactsDir() + "OdtSaveOptions.Odt11Schema.odt", saveOptions);
 
 

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

 
 Document doc = new Document(getMyDir() + "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.
 OdtSaveOptions saveOptions = new OdtSaveOptions();
 {
     saveOptions.setMeasureUnit(odtSaveMeasureUnit);
 }

 doc.save(getArtifactsDir() + "OdtSaveOptions.Odt11Schema.odt", saveOptions);
 
 

Constructor Summary

Constructors

Constructor and Description
OdtSaveOptions() Initializes a new instance of this class that can be used to save a document in the SaveFormat.ODT format.
OdtSaveOptions(int saveFormat) Initializes a new instance of this class.
OdtSaveOptions(java.lang.String password) Initializes a new instance of this class that can be used to save a document in the SaveFormat.ODT format encrypted with a password.

Method Summary

Modifier and Type	Method and Description
DigitalSignatureDetails	getDigitalSignatureDetails() Gets DigitalSignatureDetails object used to sign a document.
int	getMeasureUnit() Allows to specify units of measure to apply to document content.
java.lang.String	getPassword() Gets a password to encrypt document.
int	getSaveFormat() Specifies the format in which the document will be saved if this save options object is used.
boolean	isStrictSchema11() Specifies whether export should correspond to ODT specification 1.1 strictly.
void	isStrictSchema11(boolean value) Specifies whether export should correspond to ODT specification 1.1 strictly.
void	setDigitalSignatureDetails(DigitalSignatureDetails value) Sets DigitalSignatureDetails object used to sign a document.
void	setMeasureUnit(int value) Allows to specify units of measure to apply to document content.
void	setPassword(java.lang.String value) Sets a password to encrypt document.
void	setSaveFormat(int value) Specifies the format in which the document will be saved if this save options object is used.

Methods inherited from class com.aspose.words.SaveOptions

createSaveOptions, createSaveOptions, getAllowEmbeddingPostScriptFonts, getCustomTimeZoneInfo, getDefaultTemplate, getDml3DEffectsRenderingMode, getDmlEffectsRenderingMode, getDmlRenderingMode, getExportGeneratorName, getImlRenderingMode, getMemoryOptimization, getPrettyFormat, getProgressCallback, getTempFolder, getUpdateAmbiguousTextFont, getUpdateCreatedTimeProperty, getUpdateFields, getUpdateLastPrintedProperty, getUpdateLastSavedTimeProperty, getUseAntiAliasing, getUseHighQualityRendering, setAllowEmbeddingPostScriptFonts, setCustomTimeZoneInfo, setDefaultTemplate, setDml3DEffectsRenderingMode, setDmlEffectsRenderingMode, setDmlRenderingMode, setExportGeneratorName, setImlRenderingMode, setMemoryOptimization, setPrettyFormat, setProgressCallback, setTempFolder, setUpdateAmbiguousTextFont, setUpdateCreatedTimeProperty, setUpdateFields, setUpdateLastPrintedProperty, setUpdateLastSavedTimeProperty, setUseAntiAliasing, setUseHighQualityRendering

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OdtSaveOptions

public OdtSaveOptions()

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

Examples:

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

 
 Document doc = new Document(getMyDir() + "Rendering.docx");

 OdtSaveOptions saveOptions = new OdtSaveOptions();
 {
     saveOptions.setMeasureUnit(OdtSaveMeasureUnit.CENTIMETERS);
     saveOptions.isStrictSchema11(exportToOdt11Specs);
 }

 doc.save(getArtifactsDir() + "OdtSaveOptions.Odt11Schema.odt", saveOptions);
 
 

OdtSaveOptions

public OdtSaveOptions(java.lang.String password)

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

OdtSaveOptions

public OdtSaveOptions(int saveFormat)

Initializes a new instance of this class.

Method Detail

getSaveFormat

public int getSaveFormat()

Specifies the format in which the document will be saved if this save options object is used. Can be SaveFormat.ODT or SaveFormat.OTT.

Examples:

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

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);
 builder.writeln("Hello world!");

 // Create a new OdtSaveOptions, and pass either "SaveFormat.Odt",
 // or "SaveFormat.Ott" as the format to save the document in.
 OdtSaveOptions saveOptions = new OdtSaveOptions(saveFormat);
 saveOptions.setPassword("@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(getArtifactsDir() + "OdtSaveOptions.Encrypt" + extensionString, saveOptions);

 FileFormatInfo docInfo = FileFormatUtil.detectFileFormat(getArtifactsDir() + "OdtSaveOptions.Encrypt" + extensionString);

 Assert.assertTrue(docInfo.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 = new Document(getArtifactsDir() + "OdtSaveOptions.Encrypt" + extensionString,
         new LoadOptions("@sposeEncrypted_1145"));

 Assert.assertEquals("Hello world!", doc.getText().trim());
 
 

Specified by:

getSaveFormat in class SaveOptions

Returns:

The corresponding int value. The returned value is one of SaveFormat constants.

setSaveFormat

public void setSaveFormat(int value)

Specifies the format in which the document will be saved if this save options object is used. Can be SaveFormat.ODT or SaveFormat.OTT.

Examples:

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

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);
 builder.writeln("Hello world!");

 // Create a new OdtSaveOptions, and pass either "SaveFormat.Odt",
 // or "SaveFormat.Ott" as the format to save the document in.
 OdtSaveOptions saveOptions = new OdtSaveOptions(saveFormat);
 saveOptions.setPassword("@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(getArtifactsDir() + "OdtSaveOptions.Encrypt" + extensionString, saveOptions);

 FileFormatInfo docInfo = FileFormatUtil.detectFileFormat(getArtifactsDir() + "OdtSaveOptions.Encrypt" + extensionString);

 Assert.assertTrue(docInfo.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 = new Document(getArtifactsDir() + "OdtSaveOptions.Encrypt" + extensionString,
         new LoadOptions("@sposeEncrypted_1145"));

 Assert.assertEquals("Hello world!", doc.getText().trim());
 
 

Specified by:

setSaveFormat in class SaveOptions

Parameters:

value - The corresponding int value. The value must be one of SaveFormat constants.

isStrictSchema11

public boolean isStrictSchema11()

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.

 
 Document doc = new Document(getMyDir() + "Rendering.docx");

 OdtSaveOptions saveOptions = new OdtSaveOptions();
 {
     saveOptions.setMeasureUnit(OdtSaveMeasureUnit.CENTIMETERS);
     saveOptions.isStrictSchema11(exportToOdt11Specs);
 }

 doc.save(getArtifactsDir() + "OdtSaveOptions.Odt11Schema.odt", saveOptions);
 
 

Returns:

The corresponding boolean value.

isStrictSchema11

public void isStrictSchema11(boolean value)

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.

 
 Document doc = new Document(getMyDir() + "Rendering.docx");

 OdtSaveOptions saveOptions = new OdtSaveOptions();
 {
     saveOptions.setMeasureUnit(OdtSaveMeasureUnit.CENTIMETERS);
     saveOptions.isStrictSchema11(exportToOdt11Specs);
 }

 doc.save(getArtifactsDir() + "OdtSaveOptions.Odt11Schema.odt", saveOptions);
 
 

Parameters:

value - The corresponding boolean value.

getMeasureUnit

public int getMeasureUnit()

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

Remarks:

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

Examples:

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

 
 Document doc = new Document(getMyDir() + "Rendering.docx");

 OdtSaveOptions saveOptions = new OdtSaveOptions();
 {
     saveOptions.setMeasureUnit(OdtSaveMeasureUnit.CENTIMETERS);
     saveOptions.isStrictSchema11(exportToOdt11Specs);
 }

 doc.save(getArtifactsDir() + "OdtSaveOptions.Odt11Schema.odt", saveOptions);
 
 

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

 
 Document doc = new Document(getMyDir() + "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.
 OdtSaveOptions saveOptions = new OdtSaveOptions();
 {
     saveOptions.setMeasureUnit(odtSaveMeasureUnit);
 }

 doc.save(getArtifactsDir() + "OdtSaveOptions.Odt11Schema.odt", saveOptions);
 
 

Returns:

The corresponding int value. The returned value is one of OdtSaveMeasureUnit constants.

setMeasureUnit

public void setMeasureUnit(int value)

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

Remarks:

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

Examples:

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

 
 Document doc = new Document(getMyDir() + "Rendering.docx");

 OdtSaveOptions saveOptions = new OdtSaveOptions();
 {
     saveOptions.setMeasureUnit(OdtSaveMeasureUnit.CENTIMETERS);
     saveOptions.isStrictSchema11(exportToOdt11Specs);
 }

 doc.save(getArtifactsDir() + "OdtSaveOptions.Odt11Schema.odt", saveOptions);
 
 

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

 
 Document doc = new Document(getMyDir() + "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.
 OdtSaveOptions saveOptions = new OdtSaveOptions();
 {
     saveOptions.setMeasureUnit(odtSaveMeasureUnit);
 }

 doc.save(getArtifactsDir() + "OdtSaveOptions.Odt11Schema.odt", saveOptions);
 
 

Parameters:

value - The corresponding int value. The value must be one of OdtSaveMeasureUnit constants.

getPassword

public java.lang.String getPassword()

Gets a password to encrypt document.

Remarks:

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.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);
 builder.writeln("Hello world!");

 // Create a new OdtSaveOptions, and pass either "SaveFormat.Odt",
 // or "SaveFormat.Ott" as the format to save the document in.
 OdtSaveOptions saveOptions = new OdtSaveOptions(saveFormat);
 saveOptions.setPassword("@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(getArtifactsDir() + "OdtSaveOptions.Encrypt" + extensionString, saveOptions);

 FileFormatInfo docInfo = FileFormatUtil.detectFileFormat(getArtifactsDir() + "OdtSaveOptions.Encrypt" + extensionString);

 Assert.assertTrue(docInfo.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 = new Document(getArtifactsDir() + "OdtSaveOptions.Encrypt" + extensionString,
         new LoadOptions("@sposeEncrypted_1145"));

 Assert.assertEquals("Hello world!", doc.getText().trim());
 
 

Returns:

A password to encrypt document.

setPassword

public void setPassword(java.lang.String value)

Sets a password to encrypt document.

Remarks:

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.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);
 builder.writeln("Hello world!");

 // Create a new OdtSaveOptions, and pass either "SaveFormat.Odt",
 // or "SaveFormat.Ott" as the format to save the document in.
 OdtSaveOptions saveOptions = new OdtSaveOptions(saveFormat);
 saveOptions.setPassword("@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(getArtifactsDir() + "OdtSaveOptions.Encrypt" + extensionString, saveOptions);

 FileFormatInfo docInfo = FileFormatUtil.detectFileFormat(getArtifactsDir() + "OdtSaveOptions.Encrypt" + extensionString);

 Assert.assertTrue(docInfo.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 = new Document(getArtifactsDir() + "OdtSaveOptions.Encrypt" + extensionString,
         new LoadOptions("@sposeEncrypted_1145"));

 Assert.assertEquals("Hello world!", doc.getText().trim());
 
 

Parameters:

value - A password to encrypt document.

getDigitalSignatureDetails

public DigitalSignatureDetails getDigitalSignatureDetails()

Gets DigitalSignatureDetails object used to sign a document.

Returns:

DigitalSignatureDetails object used to sign a document.

setDigitalSignatureDetails

public void setDigitalSignatureDetails(DigitalSignatureDetails value)

Sets DigitalSignatureDetails object used to sign a document.

Parameters:

value - DigitalSignatureDetails object used to sign a document.