com.aspose.words

Class WordML2003SaveOptions

java.lang.Object

com.aspose.words.SaveOptions

com.aspose.words.WordML2003SaveOptions

public class WordML2003SaveOptions
extends SaveOptions

Can be used to specify additional options when saving a document into the SaveFormat.WORD_ML 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 may have other options added.

Examples:

Shows how to manage memory optimization.

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

 // Create a "WordML2003SaveOptions" object to pass to the document's "Save" method
 // to modify how we save the document to the WordML save format.
 WordML2003SaveOptions options = new WordML2003SaveOptions();

 // Set the "MemoryOptimization" flag to "true" to decrease memory consumption
 // during the document's saving operation at the cost of a longer saving time.
 // Set the "MemoryOptimization" flag to "false" to save the document normally.
 options.setMemoryOptimization(memoryOptimization);

 doc.save(getArtifactsDir() + "WordML2003SaveOptions.MemoryOptimization.xml", options);
 
 

Shows how to manage output document's raw content.

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

 // Create a "WordML2003SaveOptions" object to pass to the document's "Save" method
 // to modify how we save the document to the WordML save format.
 WordML2003SaveOptions options = new WordML2003SaveOptions();

 Assert.assertEquals(SaveFormat.WORD_ML, options.getSaveFormat());

 // Set the "PrettyFormat" property to "true" to apply tab character indentation and
 // newlines to make the output document's raw content easier to read.
 // Set the "PrettyFormat" property to "false" to save the document's raw content in one continuous body of the text.
 options.setPrettyFormat(prettyFormat);

 doc.save(getArtifactsDir() + "WordML2003SaveOptions.PrettyFormat.xml", options);

 String fileContents = FileUtils.readFileToString(new File(getArtifactsDir() + "WordML2003SaveOptions.PrettyFormat.xml"), StandardCharsets.UTF_8);

 if (prettyFormat)
     Assert.assertTrue(fileContents.contains(
             "<o:DocumentProperties>\r\n\t\t" +
                     "<o:Revision>1</o:Revision>\r\n\t\t" +
                     "<o:TotalTime>0</o:TotalTime>\r\n\t\t" +
                     "<o:Pages>1</o:Pages>\r\n\t\t" +
                     "<o:Words>0</o:Words>\r\n\t\t" +
                     "<o:Characters>0</o:Characters>\r\n\t\t" +
                     "<o:Lines>1</o:Lines>\r\n\t\t" +
                     "<o:Paragraphs>1</o:Paragraphs>\r\n\t\t" +
                     "<o:CharactersWithSpaces>0</o:CharactersWithSpaces>\r\n\t\t" +
                     "<o:Version>11.5606</o:Version>\r\n\t" +
                     "</o:DocumentProperties>"));
 else
     Assert.assertTrue(fileContents.contains(
             "<o:DocumentProperties><o:Revision>1</o:Revision><o:TotalTime>0</o:TotalTime><o:Pages>1</o:Pages>" +
                     "<o:Words>0</o:Words><o:Characters>0</o:Characters><o:Lines>1</o:Lines><o:Paragraphs>1</o:Paragraphs>" +
                     "<o:CharactersWithSpaces>0</o:CharactersWithSpaces><o:Version>11.5606</o:Version></o:DocumentProperties>"));
 
 

Method Summary

Modifier and Type	Method and Description
int	getSaveFormat() Specifies the format in which the document will be saved if this save options object is used.
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

Method Detail

getSaveFormat

public int getSaveFormat()

Specifies the format in which the document will be saved if this save options object is used. Can only be SaveFormat.WORD_ML.

Examples:

Shows how to manage output document's raw content.

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

 // Create a "WordML2003SaveOptions" object to pass to the document's "Save" method
 // to modify how we save the document to the WordML save format.
 WordML2003SaveOptions options = new WordML2003SaveOptions();

 Assert.assertEquals(SaveFormat.WORD_ML, options.getSaveFormat());

 // Set the "PrettyFormat" property to "true" to apply tab character indentation and
 // newlines to make the output document's raw content easier to read.
 // Set the "PrettyFormat" property to "false" to save the document's raw content in one continuous body of the text.
 options.setPrettyFormat(prettyFormat);

 doc.save(getArtifactsDir() + "WordML2003SaveOptions.PrettyFormat.xml", options);

 String fileContents = FileUtils.readFileToString(new File(getArtifactsDir() + "WordML2003SaveOptions.PrettyFormat.xml"), StandardCharsets.UTF_8);

 if (prettyFormat)
     Assert.assertTrue(fileContents.contains(
             "<o:DocumentProperties>\r\n\t\t" +
                     "<o:Revision>1</o:Revision>\r\n\t\t" +
                     "<o:TotalTime>0</o:TotalTime>\r\n\t\t" +
                     "<o:Pages>1</o:Pages>\r\n\t\t" +
                     "<o:Words>0</o:Words>\r\n\t\t" +
                     "<o:Characters>0</o:Characters>\r\n\t\t" +
                     "<o:Lines>1</o:Lines>\r\n\t\t" +
                     "<o:Paragraphs>1</o:Paragraphs>\r\n\t\t" +
                     "<o:CharactersWithSpaces>0</o:CharactersWithSpaces>\r\n\t\t" +
                     "<o:Version>11.5606</o:Version>\r\n\t" +
                     "</o:DocumentProperties>"));
 else
     Assert.assertTrue(fileContents.contains(
             "<o:DocumentProperties><o:Revision>1</o:Revision><o:TotalTime>0</o:TotalTime><o:Pages>1</o:Pages>" +
                     "<o:Words>0</o:Words><o:Characters>0</o:Characters><o:Lines>1</o:Lines><o:Paragraphs>1</o:Paragraphs>" +
                     "<o:CharactersWithSpaces>0</o:CharactersWithSpaces><o:Version>11.5606</o:Version></o:DocumentProperties>"));
 
 

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 only be SaveFormat.WORD_ML.

Examples:

Shows how to manage output document's raw content.

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

 // Create a "WordML2003SaveOptions" object to pass to the document's "Save" method
 // to modify how we save the document to the WordML save format.
 WordML2003SaveOptions options = new WordML2003SaveOptions();

 Assert.assertEquals(SaveFormat.WORD_ML, options.getSaveFormat());

 // Set the "PrettyFormat" property to "true" to apply tab character indentation and
 // newlines to make the output document's raw content easier to read.
 // Set the "PrettyFormat" property to "false" to save the document's raw content in one continuous body of the text.
 options.setPrettyFormat(prettyFormat);

 doc.save(getArtifactsDir() + "WordML2003SaveOptions.PrettyFormat.xml", options);

 String fileContents = FileUtils.readFileToString(new File(getArtifactsDir() + "WordML2003SaveOptions.PrettyFormat.xml"), StandardCharsets.UTF_8);

 if (prettyFormat)
     Assert.assertTrue(fileContents.contains(
             "<o:DocumentProperties>\r\n\t\t" +
                     "<o:Revision>1</o:Revision>\r\n\t\t" +
                     "<o:TotalTime>0</o:TotalTime>\r\n\t\t" +
                     "<o:Pages>1</o:Pages>\r\n\t\t" +
                     "<o:Words>0</o:Words>\r\n\t\t" +
                     "<o:Characters>0</o:Characters>\r\n\t\t" +
                     "<o:Lines>1</o:Lines>\r\n\t\t" +
                     "<o:Paragraphs>1</o:Paragraphs>\r\n\t\t" +
                     "<o:CharactersWithSpaces>0</o:CharactersWithSpaces>\r\n\t\t" +
                     "<o:Version>11.5606</o:Version>\r\n\t" +
                     "</o:DocumentProperties>"));
 else
     Assert.assertTrue(fileContents.contains(
             "<o:DocumentProperties><o:Revision>1</o:Revision><o:TotalTime>0</o:TotalTime><o:Pages>1</o:Pages>" +
                     "<o:Words>0</o:Words><o:Characters>0</o:Characters><o:Lines>1</o:Lines><o:Paragraphs>1</o:Paragraphs>" +
                     "<o:CharactersWithSpaces>0</o:CharactersWithSpaces><o:Version>11.5606</o:Version></o:DocumentProperties>"));
 
 

Specified by:

setSaveFormat in class SaveOptions

Parameters:

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