WordML2003SaveOptions
Inheritance: java.lang.Object, com.aspose.words.SaveOptions
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(
"\r\n\t\t" +
"1\r\n\t\t" +
"0\r\n\t\t" +
"1\r\n\t\t" +
"0\r\n\t\t" +
"0\r\n\t\t" +
"1\r\n\t\t" +
"1\r\n\t\t" +
"0\r\n\t\t" +
"11.5606\r\n\t" +
""));
else
Assert.assertTrue(fileContents.contains(
"101" +
"0011" +
"011.5606"));
Methods
| Method | Description |
|---|---|
| createSaveOptions(int saveFormat) | |
| createSaveOptions(String fileName) | Creates a save options object of a class suitable for the file extension specified in the given file name. |
| getAllowEmbeddingPostScriptFonts() | Gets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. |
| getDefaultTemplate() | Gets path to default template (including filename). |
| getDml3DEffectsRenderingMode() | Gets a value determining how 3D effects are rendered. |
| getDmlEffectsRenderingMode() | Gets a value determining how DrawingML effects are rendered. |
| getDmlRenderingMode() | Gets a value determining how DrawingML shapes are rendered. |
| getExportGeneratorName() | When true , causes the name and version of Aspose.Words to be embedded into produced files. |
| getImlRenderingMode() | Gets a value determining how ink (InkML) objects are rendered. |
| getMemoryOptimization() | Gets value determining if memory optimization should be performed before saving the document. |
| getPrettyFormat() | When true , pretty formats output where applicable. |
| getProgressCallback() | Called during saving a document and accepts data about saving progress. |
| getSaveFormat() | Specifies the format in which the document will be saved if this save options object is used. |
| getTempFolder() | Specifies the folder for temporary files used when saving to a DOC or DOCX file. |
| getUpdateCreatedTimeProperty() | Gets a value determining whether the BuiltInDocumentProperties.getCreatedTime() / BuiltInDocumentProperties.setCreatedTime(java.util.Date) property is updated before saving. |
| getUpdateFields() | Gets a value determining if fields of certain types should be updated before saving the document to a fixed page format. |
| getUpdateLastPrintedProperty() | Gets a value determining whether the BuiltInDocumentProperties.getLastPrinted() / BuiltInDocumentProperties.setLastPrinted(java.util.Date) property is updated before saving. |
| getUpdateLastSavedTimeProperty() | Gets a value determining whether the BuiltInDocumentProperties.getLastSavedTime() / BuiltInDocumentProperties.setLastSavedTime(java.util.Date) property is updated before saving. |
| getUseAntiAliasing() | Gets a value determining whether or not to use anti-aliasing for rendering. |
| getUseHighQualityRendering() | Gets a value determining whether or not to use high quality (i.e. |
| setAllowEmbeddingPostScriptFonts(boolean value) | Sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. |
| setDefaultTemplate(String value) | Sets path to default template (including filename). |
| setDml3DEffectsRenderingMode(int value) | Sets a value determining how 3D effects are rendered. |
| setDmlEffectsRenderingMode(int value) | Sets a value determining how DrawingML effects are rendered. |
| setDmlRenderingMode(int value) | Sets a value determining how DrawingML shapes are rendered. |
| setExportGeneratorName(boolean value) | When true , causes the name and version of Aspose.Words to be embedded into produced files. |
| setImlRenderingMode(int value) | Sets a value determining how ink (InkML) objects are rendered. |
| setMemoryOptimization(boolean value) | Sets value determining if memory optimization should be performed before saving the document. |
| setPrettyFormat(boolean value) | When true , pretty formats output where applicable. |
| setProgressCallback(IDocumentSavingCallback value) | Called during saving a document and accepts data about saving progress. |
| setSaveFormat(int value) | Specifies the format in which the document will be saved if this save options object is used. |
| setTempFolder(String value) | Specifies the folder for temporary files used when saving to a DOC or DOCX file. |
| setUpdateCreatedTimeProperty(boolean value) | Sets a value determining whether the BuiltInDocumentProperties.getCreatedTime() / BuiltInDocumentProperties.setCreatedTime(java.util.Date) property is updated before saving. |
| setUpdateFields(boolean value) | Sets a value determining if fields of certain types should be updated before saving the document to a fixed page format. |
| setUpdateLastPrintedProperty(boolean value) | Sets a value determining whether the BuiltInDocumentProperties.getLastPrinted() / BuiltInDocumentProperties.setLastPrinted(java.util.Date) property is updated before saving. |
| setUpdateLastSavedTimeProperty(boolean value) | Sets a value determining whether the BuiltInDocumentProperties.getLastSavedTime() / BuiltInDocumentProperties.setLastSavedTime(java.util.Date) property is updated before saving. |
| setUseAntiAliasing(boolean value) | Sets a value determining whether or not to use anti-aliasing for rendering. |
| setUseHighQualityRendering(boolean value) | Sets a value determining whether or not to use high quality (i.e. |
createSaveOptions(int saveFormat)
public static SaveOptions createSaveOptions(int saveFormat)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| saveFormat | int |
Returns: SaveOptions
createSaveOptions(String fileName)
public static SaveOptions createSaveOptions(String fileName)
Creates a save options object of a class suitable for the file extension specified in the given file name.
Examples:
Shows how to set a default template for documents that do not have attached templates.
Document doc = new Document();
// Enable automatic style updating, but do not attach a template document.
doc.setAutomaticallyUpdateStyles(true);
Assert.assertEquals("", doc.getAttachedTemplate());
// Since there is no template document, the document had nowhere to track style changes.
// Use a SaveOptions object to automatically set a template
// if a document that we are saving does not have one.
SaveOptions options = SaveOptions.createSaveOptions("Document.DefaultTemplate.docx");
options.setDefaultTemplate(getMyDir() + "Business brochure.dotx");
doc.save(getArtifactsDir() + "Document.DefaultTemplate.docx", options);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| fileName | java.lang.String | The extension of this file name determines the class of the save options object to create. |
Returns: SaveOptions - An object of a class that derives from SaveOptions.
getAllowEmbeddingPostScriptFonts()
public boolean getAllowEmbeddingPostScriptFonts()
Gets 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 .
Remarks:
Note, Word does not embed PostScript fonts, but can open documents with embedded fonts of this type.
This option only works when FontInfoCollection.getEmbedTrueTypeFonts() / FontInfoCollection.setEmbedTrueTypeFonts(boolean) of the DocumentBase.getFontInfos() property is set to true .
Examples:
Shows how to save the document with PostScript font.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.getFont().setName("PostScriptFont");
builder.writeln("Some text with PostScript font.");
// Load the font with PostScript to use in the document.
MemoryFontSource otf = new MemoryFontSource(DocumentHelper.getBytesFromStream(new FileInputStream(getFontsDir() + "AllegroOpen.otf")));
doc.setFontSettings(new FontSettings());
doc.getFontSettings().setFontsSources(new FontSourceBase[]{otf});
// Embed TrueType fonts.
doc.getFontInfos().setEmbedTrueTypeFonts(true);
// Allow embedding PostScript fonts while embedding TrueType fonts.
// Microsoft Word does not embed PostScript fonts, but can open documents with embedded fonts of this type.
SaveOptions saveOptions = SaveOptions.createSaveOptions(SaveFormat.DOCX);
saveOptions.setAllowEmbeddingPostScriptFonts(true);
doc.save(getArtifactsDir() + "Document.AllowEmbeddingPostScriptFonts.docx", saveOptions);
Returns: boolean - A boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved.
getDefaultTemplate()
public String getDefaultTemplate()
Gets path to default template (including filename). Default value for this property is empty string.
Remarks:
If specified, this path is used to load template when Document.getAutomaticallyUpdateStyles() / Document.setAutomaticallyUpdateStyles(boolean) is true , but Document.getAttachedTemplate() / Document.setAttachedTemplate(java.lang.String) is empty.
Examples:
Shows how to set a default template for documents that do not have attached templates.
Document doc = new Document();
// Enable automatic style updating, but do not attach a template document.
doc.setAutomaticallyUpdateStyles(true);
Assert.assertEquals("", doc.getAttachedTemplate());
// Since there is no template document, the document had nowhere to track style changes.
// Use a SaveOptions object to automatically set a template
// if a document that we are saving does not have one.
SaveOptions options = SaveOptions.createSaveOptions("Document.DefaultTemplate.docx");
options.setDefaultTemplate(getMyDir() + "Business brochure.dotx");
doc.save(getArtifactsDir() + "Document.DefaultTemplate.docx", options);
Returns: java.lang.String - Path to default template (including filename).
getDml3DEffectsRenderingMode()
public int getDml3DEffectsRenderingMode()
Gets a value determining how 3D effects are rendered.
Remarks:
The default value is Dml3DEffectsRenderingMode.BASIC.
Examples:
Shows how 3D effects are rendered.
Document doc = new Document(getMyDir() + "DrawingML shape 3D effects.docx");
RenderCallback warningCallback = new RenderCallback();
doc.setWarningCallback(warningCallback);
PdfSaveOptions saveOptions = new PdfSaveOptions();
saveOptions.setDml3DEffectsRenderingMode(Dml3DEffectsRenderingMode.ADVANCED);
doc.save(getArtifactsDir() + "PdfSaveOptions.Dml3DEffectsRenderingModeTest.pdf", saveOptions);
Returns: int - A value determining how 3D effects are rendered. The returned value is one of Dml3DEffectsRenderingMode constants.
getDmlEffectsRenderingMode()
public int getDmlEffectsRenderingMode()
Gets a value determining how DrawingML effects are rendered.
Remarks:
The default value is DmlEffectsRenderingMode.SIMPLIFIED.
This property is used when the document is exported to fixed page formats.
Examples:
Shows how to configure the rendering quality of DrawingML effects in a document as we save it to PDF.
Document doc = new Document(getMyDir() + "DrawingML shape effects.docx");
// Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
// to modify how that method converts the document to .PDF.
PdfSaveOptions options = new PdfSaveOptions();
// Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.None" to discard all DrawingML effects.
// Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.Simplified"
// to render a simplified version of DrawingML effects.
// Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.Fine" to
// render DrawingML effects with more accuracy and also with more processing cost.
options.setDmlEffectsRenderingMode(effectsRenderingMode);
Assert.assertEquals(DmlRenderingMode.DRAWING_ML, options.getDmlRenderingMode());
doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingMLEffects.pdf", options);
Returns: int - A value determining how DrawingML effects are rendered. The returned value is one of DmlEffectsRenderingMode constants.
getDmlRenderingMode()
public int getDmlRenderingMode()
Gets a value determining how DrawingML shapes are rendered.
Remarks:
The default value is DmlRenderingMode.FALLBACK.
This property is used when the document is exported to fixed page formats.
Examples:
Shows how to render fallback shapes when saving to PDF.
Document doc = new Document(getMyDir() + "DrawingML shape fallbacks.docx");
// Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
// to modify how that method converts the document to .PDF.
PdfSaveOptions options = new PdfSaveOptions();
// Set the "DmlRenderingMode" property to "DmlRenderingMode.Fallback"
// to substitute DML shapes with their fallback shapes.
// Set the "DmlRenderingMode" property to "DmlRenderingMode.DrawingML"
// to render the DML shapes themselves.
options.setDmlRenderingMode(dmlRenderingMode);
doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingMLFallback.pdf", options);
Shows how to configure the rendering quality of DrawingML effects in a document as we save it to PDF.
Document doc = new Document(getMyDir() + "DrawingML shape effects.docx");
// Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
// to modify how that method converts the document to .PDF.
PdfSaveOptions options = new PdfSaveOptions();
// Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.None" to discard all DrawingML effects.
// Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.Simplified"
// to render a simplified version of DrawingML effects.
// Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.Fine" to
// render DrawingML effects with more accuracy and also with more processing cost.
options.setDmlEffectsRenderingMode(effectsRenderingMode);
Assert.assertEquals(DmlRenderingMode.DRAWING_ML, options.getDmlRenderingMode());
doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingMLEffects.pdf", options);
Returns: int - A value determining how DrawingML shapes are rendered. The returned value is one of DmlRenderingMode constants.
getExportGeneratorName()
public boolean getExportGeneratorName()
When true , causes the name and version of Aspose.Words to be embedded into produced files. Default value is true .
Examples:
Shows how to disable adding name and version of Aspose.Words into produced files.
Document doc = new Document();
// Use https://docs.aspose.com/words/net/generator-or-producer-name-included-in-output-documents/ to know how to check the result.
OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); { saveOptions.setExportGeneratorName(false); }
doc.save(getArtifactsDir() + "OoxmlSaveOptions.ExportGeneratorName.docx", saveOptions);
Returns: boolean - The corresponding boolean value.
getImlRenderingMode()
public int getImlRenderingMode()
Gets a value determining how ink (InkML) objects are rendered.
Remarks:
The default value is ImlRenderingMode.INK_ML.
This property is used when the document is exported to fixed page formats.
Examples:
Shows how to render Ink object.
Document doc = new Document(getMyDir() + "Ink object.docx");
// Set 'ImlRenderingMode.InkML' ignores fall-back shape of ink (InkML) object and renders InkML itself.
// If the rendering result is unsatisfactory,
// please use 'ImlRenderingMode.Fallback' to get a result similar to previous versions.
ImageSaveOptions saveOptions = new ImageSaveOptions(SaveFormat.JPEG);
{
saveOptions.setImlRenderingMode(ImlRenderingMode.INK_ML);
}
doc.save(getArtifactsDir() + "ImageSaveOptions.RenderInkObject.jpeg", saveOptions);
Returns: int - A value determining how ink (InkML) objects are rendered. The returned value is one of ImlRenderingMode constants.
getMemoryOptimization()
public boolean getMemoryOptimization()
Gets value determining if memory optimization should be performed before saving the document. Default value for this property is false .
Remarks:
Setting this option to true can significantly decrease memory consumption while saving large documents at the cost of slower saving time.
Examples:
Shows an option to optimize memory consumption when rendering large documents to PDF.
Document doc = new Document(getMyDir() + "Rendering.docx");
// Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
// to modify how that method converts the document to .PDF.
SaveOptions saveOptions = SaveOptions.createSaveOptions(SaveFormat.PDF);
// Set the "MemoryOptimization" property to "true" to lower the memory footprint of large documents' saving operations
// at the cost of increasing the duration of the operation.
// Set the "MemoryOptimization" property to "false" to save the document as a PDF normally.
saveOptions.setMemoryOptimization(memoryOptimization);
doc.save(getArtifactsDir() + "PdfSaveOptions.MemoryOptimization.pdf", saveOptions);
Returns: boolean - Value determining if memory optimization should be performed before saving the document.
getPrettyFormat()
public boolean getPrettyFormat()
When true , pretty formats output where applicable. Default value is false .
Remarks:
Set to true to make HTML, MHTML, EPUB, WordML, RTF, DOCX and ODT output human readable. Useful for testing or debugging.
Examples:
Shows how to enhance the readability of the raw code of a saved .html document.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.writeln("Hello world!");
HtmlSaveOptions htmlOptions = new HtmlSaveOptions(SaveFormat.HTML);
{
htmlOptions.setPrettyFormat(usePrettyFormat);
}
doc.save(getArtifactsDir() + "HtmlSaveOptions.PrettyFormat.html", htmlOptions);
// Enabling pretty format makes the raw html code more readable by adding tab stop and new line characters.
String html = FileUtils.readFileToString(new File(getArtifactsDir() + "HtmlSaveOptions.PrettyFormat.html"), StandardCharsets.UTF_8);
if (usePrettyFormat)
Assert.assertEquals(
"\r\n" +
"\t\r\n" +
"\t\t\r\n" +
"\t\t\r\n" +
MessageFormat.format("\t\t\r\n", BuildVersionInfo.getProduct(), BuildVersionInfo.getVersion()) +
"\t\t\r\n" +
"\t\t\r\n" +
"\t\r\n" +
"\t\r\n" +
"\t\t \r\n" +
"\t\t\t \r\n" +
"\t\t\t\tHello world!\r\n" +
"\t\t\t\r\n" +
"\t\t\t \r\n" +
"\t\t\t\t\r\n" +
"\t\t\t\r\n" +
"\t\t\r\n" +
"\t\r\n",
html);
else
Assert.assertEquals(
"" +
"" +
MessageFormat.format("", BuildVersionInfo.getProduct(), BuildVersionInfo.getVersion()) +
"" +
" Hello world!" +
" ",
html);
Returns: boolean - The corresponding boolean value.
getProgressCallback()
public IDocumentSavingCallback getProgressCallback()
Called during saving a document and accepts data about saving progress.
Remarks:
Progress is reported when saving to SaveFormat.DOCX, SaveFormat.FLAT_OPC, SaveFormat.DOCM, SaveFormat.DOTM, SaveFormat.DOTX, SaveFormat.DOC, SaveFormat.DOT, SaveFormat.HTML, SaveFormat.MHTML, SaveFormat.EPUB, SaveFormat.XAML_FLOW, or SaveFormat.XAML_FLOW_PACK.
Examples:
Shows how to manage a document while saving to xamlflow.
public void progressCallback(int saveFormat, String ext) throws Exception
{
Document doc = new Document(getMyDir() + "Big document.docx");
// Following formats are supported: XamlFlow, XamlFlowPack.
XamlFlowSaveOptions saveOptions = new XamlFlowSaveOptions(saveFormat);
{
saveOptions.setProgressCallback(new SavingProgressCallback());
}
try {
doc.save(getArtifactsDir() + MessageFormat.format("XamlFlowSaveOptions.ProgressCallback.{0}", ext), saveOptions);
}
catch (IllegalStateException exception) {
Assert.assertTrue(exception.getMessage().contains("EstimatedProgress"));
}
}
public static Object[][] progressCallbackDataProvider() throws Exception
{
return new Object[][]
{
{SaveFormat.XAML_FLOW, "xamlflow"},
{SaveFormat.XAML_FLOW_PACK, "xamlflowpack"},
};
}
///
/// Saving progress callback. Cancel a document saving after the "MaxDuration" seconds.
///
public static class SavingProgressCallback implements IDocumentSavingCallback
{
///
/// Ctr.
///
public SavingProgressCallback()
{
mSavingStartedAt = new Date();
}
///
/// Callback method which called during document saving.
///
/// Saving arguments.
public void notify(DocumentSavingArgs args)
{
Date canceledAt = new Date();
long diff = canceledAt.getTime() - mSavingStartedAt.getTime();
long ellapsedSeconds = TimeUnit.MILLISECONDS.toSeconds(diff);
if (ellapsedSeconds > MAX_DURATION)
throw new IllegalStateException(MessageFormat.format("EstimatedProgress = {0}; CanceledAt = {1}", args.getEstimatedProgress(), canceledAt));
}
///
/// Date and time when document saving is started.
///
private Date mSavingStartedAt;
///
/// Maximum allowed duration in sec.
///
private static final double MAX_DURATION = 0.01d;
}
Shows how to manage a document while saving to html.
public void progressCallback(int saveFormat, String ext) throws Exception
{
Document doc = new Document(getMyDir() + "Big document.docx");
// Following formats are supported: Html, Mhtml, Epub.
HtmlSaveOptions saveOptions = new HtmlSaveOptions(saveFormat);
{
saveOptions.setProgressCallback(new SavingProgressCallback());
}
try {
doc.save(getArtifactsDir() + MessageFormat.format("HtmlSaveOptions.ProgressCallback.{0}", ext), saveOptions);
}
catch (IllegalStateException exception) {
Assert.assertTrue(exception.getMessage().contains("EstimatedProgress"));
}
}
public static Object[][] progressCallbackDataProvider() throws Exception
{
return new Object[][]
{
{SaveFormat.HTML, "html"},
{SaveFormat.MHTML, "mhtml"},
{SaveFormat.EPUB, "epub"},
};
}
///
/// Saving progress callback. Cancel a document saving after the "MaxDuration" seconds.
///
public static class SavingProgressCallback implements IDocumentSavingCallback
{
///
/// Ctr.
///
public SavingProgressCallback()
{
mSavingStartedAt = new Date();
}
///
/// Callback method which called during document saving.
///
/// Saving arguments.
public void notify(DocumentSavingArgs args)
{
Date canceledAt = new Date();
long diff = canceledAt.getTime() - mSavingStartedAt.getTime();
long ellapsedSeconds = TimeUnit.MILLISECONDS.toSeconds(diff);
if (ellapsedSeconds > MAX_DURATION)
throw new IllegalStateException(MessageFormat.format("EstimatedProgress = {0}; CanceledAt = {1}", args.getEstimatedProgress(), canceledAt));
}
///
/// Date and time when document saving is started.
///
private Date mSavingStartedAt;
///
/// Maximum allowed duration in sec.
///
private static final double MAX_DURATION = 0.01d;
}
Shows how to manage a document while saving to docx.
public void progressCallback(int saveFormat, String ext) throws Exception
{
Document doc = new Document(getMyDir() + "Big document.docx");
// Following formats are supported: Docx, FlatOpc, Docm, Dotm, Dotx.
OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(saveFormat);
{
saveOptions.setProgressCallback(new SavingProgressCallback());
}
try {
doc.save(getArtifactsDir() + MessageFormat.format("OoxmlSaveOptions.ProgressCallback.{0}", ext), saveOptions);
}
catch (IllegalStateException exception) {
Assert.assertTrue(exception.getMessage().contains("EstimatedProgress"));
}
}
public static Object[][] progressCallbackDataProvider() throws Exception
{
return new Object[][]
{
{SaveFormat.DOCX, "docx"},
{SaveFormat.DOCM, "docm"},
{SaveFormat.DOTM, "dotm"},
{SaveFormat.DOTX, "dotx"},
{SaveFormat.FLAT_OPC, "flatopc"},
};
}
///
/// Saving progress callback. Cancel a document saving after the "MaxDuration" seconds.
///
public static class SavingProgressCallback implements IDocumentSavingCallback
{
///
/// Ctr.
///
public SavingProgressCallback()
{
mSavingStartedAt = new Date();
}
///
/// Callback method which called during document saving.
///
/// Saving arguments.
public void notify(DocumentSavingArgs args)
{
Date canceledAt = new Date();
long diff = canceledAt.getTime() - mSavingStartedAt.getTime();
long ellapsedSeconds = TimeUnit.MILLISECONDS.toSeconds(diff);
if (ellapsedSeconds > MAX_DURATION)
throw new IllegalStateException(MessageFormat.format("EstimatedProgress = {0}; CanceledAt = {1}", args.getEstimatedProgress(), canceledAt));
}
///
/// Date and time when document saving is started.
///
private Date mSavingStartedAt;
///
/// Maximum allowed duration in sec.
///
private static final double MAX_DURATION = 0.01d;
}
Returns: IDocumentSavingCallback - The corresponding IDocumentSavingCallback value.
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(
"\r\n\t\t" +
"1\r\n\t\t" +
"0\r\n\t\t" +
"1\r\n\t\t" +
"0\r\n\t\t" +
"0\r\n\t\t" +
"1\r\n\t\t" +
"1\r\n\t\t" +
"0\r\n\t\t" +
"11.5606\r\n\t" +
""));
else
Assert.assertTrue(fileContents.contains(
"101" +
"0011" +
"011.5606"));
Returns: int - The corresponding int value. The returned value is one of SaveFormat constants.
getTempFolder()
public String getTempFolder()
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.
Returns: java.lang.String - The corresponding java.lang.String value.
getUpdateCreatedTimeProperty()
public boolean getUpdateCreatedTimeProperty()
Gets a value determining whether the BuiltInDocumentProperties.getCreatedTime() / BuiltInDocumentProperties.setCreatedTime(java.util.Date) property is updated before saving. Default value is false ;
Examples:
Shows how to update a document’s “CreatedTime” property when saving.
Document doc = new Document();
Calendar calendar = Calendar.getInstance();
calendar.set(2019, 11, 20);
doc.getBuiltInDocumentProperties().setCreatedTime(calendar.getTime());
// This flag determines whether the created time, which is a built-in property, is updated.
// If so, then the date of the document's most recent save operation
// with this SaveOptions object passed as a parameter is used as the created time.
DocSaveOptions saveOptions = new DocSaveOptions();
saveOptions.setUpdateCreatedTimeProperty(isUpdateCreatedTimeProperty);
doc.save(getArtifactsDir() + "DocSaveOptions.UpdateCreatedTimeProperty.docx", saveOptions);
Returns: boolean - A value determining whether the BuiltInDocumentProperties.getCreatedTime() / BuiltInDocumentProperties.setCreatedTime(java.util.Date) property is updated before saving.
getUpdateFields()
public boolean getUpdateFields()
Gets 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 .
Remarks:
Allows to specify whether to mimic or not MS Word behavior.
Examples:
Shows how to update all the fields in a document immediately before saving it to PDF.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert text with PAGE and NUMPAGES fields. These fields do not display the correct value in real time.
// We will need to manually update them using updating methods such as "Field.Update()", and "Document.UpdateFields()"
// each time we need them to display accurate values.
builder.write("Page ");
builder.insertField("PAGE", "");
builder.write(" of ");
builder.insertField("NUMPAGES", "");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Hello World!");
// Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
// to modify how that method converts the document to .PDF.
PdfSaveOptions options = new PdfSaveOptions();
// Set the "UpdateFields" property to "false" to not update all the fields in a document right before a save operation.
// This is the preferable option if we know that all our fields will be up to date before saving.
// Set the "UpdateFields" property to "true" to iterate through all the document
// fields and update them before we save it as a PDF. This will make sure that all the fields will display
// the most accurate values in the PDF.
options.setUpdateFields(updateFields);
// We can clone PdfSaveOptions objects.
Assert.assertNotSame(options, options.deepClone());
doc.save(getArtifactsDir() + "PdfSaveOptions.UpdateFields.pdf", options);
Returns: boolean - A value determining if fields of certain types should be updated before saving the document to a fixed page format.
getUpdateLastPrintedProperty()
public boolean getUpdateLastPrintedProperty()
Gets a value determining whether the BuiltInDocumentProperties.getLastPrinted() / BuiltInDocumentProperties.setLastPrinted(java.util.Date) property is updated before saving.
Examples:
Shows how to update a document’s “Last printed” property when saving.
Document doc = new Document();
Calendar calendar = Calendar.getInstance();
calendar.set(2019, 11, 20);
doc.getBuiltInDocumentProperties().setLastPrinted(calendar.getTime());
// This flag determines whether the last printed date, which is a built-in property, is updated.
// If so, then the date of the document's most recent save operation
// with this SaveOptions object passed as a parameter is used as the print date.
DocSaveOptions saveOptions = new DocSaveOptions();
saveOptions.setUpdateLastPrintedProperty(isUpdateLastPrintedProperty);
// In Microsoft Word 2003, this property can be found via File -> Properties -> Statistics -> Printed.
// It can also be displayed in the document's body by using a PRINTDATE field.
doc.save(getArtifactsDir() + "DocSaveOptions.UpdateLastPrintedProperty.doc", saveOptions);
Returns: boolean - A value determining whether the BuiltInDocumentProperties.getLastPrinted() / BuiltInDocumentProperties.setLastPrinted(java.util.Date) property is updated before saving.
getUpdateLastSavedTimeProperty()
public boolean getUpdateLastSavedTimeProperty()
Gets a value determining whether the BuiltInDocumentProperties.getLastSavedTime() / BuiltInDocumentProperties.setLastSavedTime(java.util.Date) property is updated before saving.
Examples:
Shows how to determine whether to preserve the document’s “Last saved time” property when saving.
Document doc = new Document(getMyDir() + "Document.docx");
// When we save the document to an OOXML format, we can create an OoxmlSaveOptions object
// and then pass it to the document's saving method to modify how we save the document.
// Set the "UpdateLastSavedTimeProperty" property to "true" to
// set the output document's "Last saved time" built-in property to the current date/time.
// Set the "UpdateLastSavedTimeProperty" property to "false" to
// preserve the original value of the input document's "Last saved time" built-in property.
OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
saveOptions.setUpdateLastSavedTimeProperty(updateLastSavedTimeProperty);
doc.save(getArtifactsDir() + "OoxmlSaveOptions.LastSavedTime.docx", saveOptions);
Returns: boolean - A value determining whether the BuiltInDocumentProperties.getLastSavedTime() / BuiltInDocumentProperties.setLastSavedTime(java.util.Date) property is updated before saving.
getUseAntiAliasing()
public boolean getUseAntiAliasing()
Gets a value determining whether or not to use anti-aliasing for rendering.
Remarks:
The default value is false . When this value is set to true anti-aliasing is used for rendering.
This property is used when the document is exported to the following formats: SaveFormat.TIFF, SaveFormat.PNG, SaveFormat.BMP, SaveFormat.JPEG, SaveFormat.EMF. When the document is exported to the SaveFormat.HTML, SaveFormat.MHTML, SaveFormat.EPUB, SaveFormat.AZW_3 or SaveFormat.MOBI formats this option is used for raster images.
Examples:
Shows how to improve the quality of a rendered document with SaveOptions.
Document doc = new Document(getMyDir() + "Rendering.docx");
DocumentBuilder builder = new DocumentBuilder(doc);
builder.getFont().setSize(60.0);
builder.writeln("Some text.");
SaveOptions options = new ImageSaveOptions(SaveFormat.JPEG);
doc.save(getArtifactsDir() + "Document.ImageSaveOptions.Default.jpg", options);
options.setUseAntiAliasing(true);
options.setUseHighQualityRendering(true);
doc.save(getArtifactsDir() + "Document.ImageSaveOptions.HighQuality.jpg", options);
Returns: boolean - A value determining whether or not to use anti-aliasing for rendering.
getUseHighQualityRendering()
public boolean getUseHighQualityRendering()
Gets a value determining whether or not to use high quality (i.e. slow) rendering algorithms.
Remarks:
The default value is false .
This property is used when the document is exported to image formats: SaveFormat.TIFF, SaveFormat.PNG, SaveFormat.BMP, SaveFormat.JPEG, SaveFormat.EMF.
Examples:
Shows how to improve the quality of a rendered document with SaveOptions.
Document doc = new Document(getMyDir() + "Rendering.docx");
DocumentBuilder builder = new DocumentBuilder(doc);
builder.getFont().setSize(60.0);
builder.writeln("Some text.");
SaveOptions options = new ImageSaveOptions(SaveFormat.JPEG);
doc.save(getArtifactsDir() + "Document.ImageSaveOptions.Default.jpg", options);
options.setUseAntiAliasing(true);
options.setUseHighQualityRendering(true);
doc.save(getArtifactsDir() + "Document.ImageSaveOptions.HighQuality.jpg", options);
Returns: boolean - A value determining whether or not to use high quality (i.e.
setAllowEmbeddingPostScriptFonts(boolean value)
public void setAllowEmbeddingPostScriptFonts(boolean value)
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 .
Remarks:
Note, Word does not embed PostScript fonts, but can open documents with embedded fonts of this type.
This option only works when FontInfoCollection.getEmbedTrueTypeFonts() / FontInfoCollection.setEmbedTrueTypeFonts(boolean) of the DocumentBase.getFontInfos() property is set to true .
Examples:
Shows how to save the document with PostScript font.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.getFont().setName("PostScriptFont");
builder.writeln("Some text with PostScript font.");
// Load the font with PostScript to use in the document.
MemoryFontSource otf = new MemoryFontSource(DocumentHelper.getBytesFromStream(new FileInputStream(getFontsDir() + "AllegroOpen.otf")));
doc.setFontSettings(new FontSettings());
doc.getFontSettings().setFontsSources(new FontSourceBase[]{otf});
// Embed TrueType fonts.
doc.getFontInfos().setEmbedTrueTypeFonts(true);
// Allow embedding PostScript fonts while embedding TrueType fonts.
// Microsoft Word does not embed PostScript fonts, but can open documents with embedded fonts of this type.
SaveOptions saveOptions = SaveOptions.createSaveOptions(SaveFormat.DOCX);
saveOptions.setAllowEmbeddingPostScriptFonts(true);
doc.save(getArtifactsDir() + "Document.AllowEmbeddingPostScriptFonts.docx", saveOptions);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | A boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. |
setDefaultTemplate(String value)
public void setDefaultTemplate(String value)
Sets path to default template (including filename). Default value for this property is empty string.
Remarks:
If specified, this path is used to load template when Document.getAutomaticallyUpdateStyles() / Document.setAutomaticallyUpdateStyles(boolean) is true , but Document.getAttachedTemplate() / Document.setAttachedTemplate(java.lang.String) is empty.
Examples:
Shows how to set a default template for documents that do not have attached templates.
Document doc = new Document();
// Enable automatic style updating, but do not attach a template document.
doc.setAutomaticallyUpdateStyles(true);
Assert.assertEquals("", doc.getAttachedTemplate());
// Since there is no template document, the document had nowhere to track style changes.
// Use a SaveOptions object to automatically set a template
// if a document that we are saving does not have one.
SaveOptions options = SaveOptions.createSaveOptions("Document.DefaultTemplate.docx");
options.setDefaultTemplate(getMyDir() + "Business brochure.dotx");
doc.save(getArtifactsDir() + "Document.DefaultTemplate.docx", options);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | Path to default template (including filename). |
setDml3DEffectsRenderingMode(int value)
public void setDml3DEffectsRenderingMode(int value)
Sets a value determining how 3D effects are rendered.
Remarks:
The default value is Dml3DEffectsRenderingMode.BASIC.
Examples:
Shows how 3D effects are rendered.
Document doc = new Document(getMyDir() + "DrawingML shape 3D effects.docx");
RenderCallback warningCallback = new RenderCallback();
doc.setWarningCallback(warningCallback);
PdfSaveOptions saveOptions = new PdfSaveOptions();
saveOptions.setDml3DEffectsRenderingMode(Dml3DEffectsRenderingMode.ADVANCED);
doc.save(getArtifactsDir() + "PdfSaveOptions.Dml3DEffectsRenderingModeTest.pdf", saveOptions);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | A value determining how 3D effects are rendered. The value must be one of Dml3DEffectsRenderingMode constants. |
setDmlEffectsRenderingMode(int value)
public void setDmlEffectsRenderingMode(int value)
Sets a value determining how DrawingML effects are rendered.
Remarks:
The default value is DmlEffectsRenderingMode.SIMPLIFIED.
This property is used when the document is exported to fixed page formats.
Examples:
Shows how to configure the rendering quality of DrawingML effects in a document as we save it to PDF.
Document doc = new Document(getMyDir() + "DrawingML shape effects.docx");
// Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
// to modify how that method converts the document to .PDF.
PdfSaveOptions options = new PdfSaveOptions();
// Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.None" to discard all DrawingML effects.
// Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.Simplified"
// to render a simplified version of DrawingML effects.
// Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.Fine" to
// render DrawingML effects with more accuracy and also with more processing cost.
options.setDmlEffectsRenderingMode(effectsRenderingMode);
Assert.assertEquals(DmlRenderingMode.DRAWING_ML, options.getDmlRenderingMode());
doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingMLEffects.pdf", options);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | A value determining how DrawingML effects are rendered. The value must be one of DmlEffectsRenderingMode constants. |
setDmlRenderingMode(int value)
public void setDmlRenderingMode(int value)
Sets a value determining how DrawingML shapes are rendered.
Remarks:
The default value is DmlRenderingMode.FALLBACK.
This property is used when the document is exported to fixed page formats.
Examples:
Shows how to render fallback shapes when saving to PDF.
Document doc = new Document(getMyDir() + "DrawingML shape fallbacks.docx");
// Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
// to modify how that method converts the document to .PDF.
PdfSaveOptions options = new PdfSaveOptions();
// Set the "DmlRenderingMode" property to "DmlRenderingMode.Fallback"
// to substitute DML shapes with their fallback shapes.
// Set the "DmlRenderingMode" property to "DmlRenderingMode.DrawingML"
// to render the DML shapes themselves.
options.setDmlRenderingMode(dmlRenderingMode);
doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingMLFallback.pdf", options);
Shows how to configure the rendering quality of DrawingML effects in a document as we save it to PDF.
Document doc = new Document(getMyDir() + "DrawingML shape effects.docx");
// Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
// to modify how that method converts the document to .PDF.
PdfSaveOptions options = new PdfSaveOptions();
// Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.None" to discard all DrawingML effects.
// Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.Simplified"
// to render a simplified version of DrawingML effects.
// Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.Fine" to
// render DrawingML effects with more accuracy and also with more processing cost.
options.setDmlEffectsRenderingMode(effectsRenderingMode);
Assert.assertEquals(DmlRenderingMode.DRAWING_ML, options.getDmlRenderingMode());
doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingMLEffects.pdf", options);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | A value determining how DrawingML shapes are rendered. The value must be one of DmlRenderingMode constants. |
setExportGeneratorName(boolean value)
public void setExportGeneratorName(boolean value)
When true , causes the name and version of Aspose.Words to be embedded into produced files. Default value is true .
Examples:
Shows how to disable adding name and version of Aspose.Words into produced files.
Document doc = new Document();
// Use https://docs.aspose.com/words/net/generator-or-producer-name-included-in-output-documents/ to know how to check the result.
OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); { saveOptions.setExportGeneratorName(false); }
doc.save(getArtifactsDir() + "OoxmlSaveOptions.ExportGeneratorName.docx", saveOptions);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The corresponding boolean value. |
setImlRenderingMode(int value)
public void setImlRenderingMode(int value)
Sets a value determining how ink (InkML) objects are rendered.
Remarks:
The default value is ImlRenderingMode.INK_ML.
This property is used when the document is exported to fixed page formats.
Examples:
Shows how to render Ink object.
Document doc = new Document(getMyDir() + "Ink object.docx");
// Set 'ImlRenderingMode.InkML' ignores fall-back shape of ink (InkML) object and renders InkML itself.
// If the rendering result is unsatisfactory,
// please use 'ImlRenderingMode.Fallback' to get a result similar to previous versions.
ImageSaveOptions saveOptions = new ImageSaveOptions(SaveFormat.JPEG);
{
saveOptions.setImlRenderingMode(ImlRenderingMode.INK_ML);
}
doc.save(getArtifactsDir() + "ImageSaveOptions.RenderInkObject.jpeg", saveOptions);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | A value determining how ink (InkML) objects are rendered. The value must be one of ImlRenderingMode constants. |
setMemoryOptimization(boolean value)
public void setMemoryOptimization(boolean value)
Sets value determining if memory optimization should be performed before saving the document. Default value for this property is false .
Remarks:
Setting this option to true can significantly decrease memory consumption while saving large documents at the cost of slower saving time.
Examples:
Shows an option to optimize memory consumption when rendering large documents to PDF.
Document doc = new Document(getMyDir() + "Rendering.docx");
// Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
// to modify how that method converts the document to .PDF.
SaveOptions saveOptions = SaveOptions.createSaveOptions(SaveFormat.PDF);
// Set the "MemoryOptimization" property to "true" to lower the memory footprint of large documents' saving operations
// at the cost of increasing the duration of the operation.
// Set the "MemoryOptimization" property to "false" to save the document as a PDF normally.
saveOptions.setMemoryOptimization(memoryOptimization);
doc.save(getArtifactsDir() + "PdfSaveOptions.MemoryOptimization.pdf", saveOptions);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | Value determining if memory optimization should be performed before saving the document. |
setPrettyFormat(boolean value)
public void setPrettyFormat(boolean value)
When true , pretty formats output where applicable. Default value is false .
Remarks:
Set to true to make HTML, MHTML, EPUB, WordML, RTF, DOCX and ODT output human readable. Useful for testing or debugging.
Examples:
Shows how to enhance the readability of the raw code of a saved .html document.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.writeln("Hello world!");
HtmlSaveOptions htmlOptions = new HtmlSaveOptions(SaveFormat.HTML);
{
htmlOptions.setPrettyFormat(usePrettyFormat);
}
doc.save(getArtifactsDir() + "HtmlSaveOptions.PrettyFormat.html", htmlOptions);
// Enabling pretty format makes the raw html code more readable by adding tab stop and new line characters.
String html = FileUtils.readFileToString(new File(getArtifactsDir() + "HtmlSaveOptions.PrettyFormat.html"), StandardCharsets.UTF_8);
if (usePrettyFormat)
Assert.assertEquals(
"\r\n" +
"\t\r\n" +
"\t\t\r\n" +
"\t\t\r\n" +
MessageFormat.format("\t\t\r\n", BuildVersionInfo.getProduct(), BuildVersionInfo.getVersion()) +
"\t\t\r\n" +
"\t\t\r\n" +
"\t\r\n" +
"\t\r\n" +
"\t\t \r\n" +
"\t\t\t \r\n" +
"\t\t\t\tHello world!\r\n" +
"\t\t\t\r\n" +
"\t\t\t \r\n" +
"\t\t\t\t\r\n" +
"\t\t\t\r\n" +
"\t\t\r\n" +
"\t\r\n",
html);
else
Assert.assertEquals(
"" +
"" +
MessageFormat.format("", BuildVersionInfo.getProduct(), BuildVersionInfo.getVersion()) +
"" +
" Hello world!" +
" ",
html);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The corresponding boolean value. |
setProgressCallback(IDocumentSavingCallback value)
public void setProgressCallback(IDocumentSavingCallback value)
Called during saving a document and accepts data about saving progress.
Remarks:
Progress is reported when saving to SaveFormat.DOCX, SaveFormat.FLAT_OPC, SaveFormat.DOCM, SaveFormat.DOTM, SaveFormat.DOTX, SaveFormat.DOC, SaveFormat.DOT, SaveFormat.HTML, SaveFormat.MHTML, SaveFormat.EPUB, SaveFormat.XAML_FLOW, or SaveFormat.XAML_FLOW_PACK.
Examples:
Shows how to manage a document while saving to xamlflow.
public void progressCallback(int saveFormat, String ext) throws Exception
{
Document doc = new Document(getMyDir() + "Big document.docx");
// Following formats are supported: XamlFlow, XamlFlowPack.
XamlFlowSaveOptions saveOptions = new XamlFlowSaveOptions(saveFormat);
{
saveOptions.setProgressCallback(new SavingProgressCallback());
}
try {
doc.save(getArtifactsDir() + MessageFormat.format("XamlFlowSaveOptions.ProgressCallback.{0}", ext), saveOptions);
}
catch (IllegalStateException exception) {
Assert.assertTrue(exception.getMessage().contains("EstimatedProgress"));
}
}
public static Object[][] progressCallbackDataProvider() throws Exception
{
return new Object[][]
{
{SaveFormat.XAML_FLOW, "xamlflow"},
{SaveFormat.XAML_FLOW_PACK, "xamlflowpack"},
};
}
///
/// Saving progress callback. Cancel a document saving after the "MaxDuration" seconds.
///
public static class SavingProgressCallback implements IDocumentSavingCallback
{
///
/// Ctr.
///
public SavingProgressCallback()
{
mSavingStartedAt = new Date();
}
///
/// Callback method which called during document saving.
///
/// Saving arguments.
public void notify(DocumentSavingArgs args)
{
Date canceledAt = new Date();
long diff = canceledAt.getTime() - mSavingStartedAt.getTime();
long ellapsedSeconds = TimeUnit.MILLISECONDS.toSeconds(diff);
if (ellapsedSeconds > MAX_DURATION)
throw new IllegalStateException(MessageFormat.format("EstimatedProgress = {0}; CanceledAt = {1}", args.getEstimatedProgress(), canceledAt));
}
///
/// Date and time when document saving is started.
///
private Date mSavingStartedAt;
///
/// Maximum allowed duration in sec.
///
private static final double MAX_DURATION = 0.01d;
}
Shows how to manage a document while saving to html.
public void progressCallback(int saveFormat, String ext) throws Exception
{
Document doc = new Document(getMyDir() + "Big document.docx");
// Following formats are supported: Html, Mhtml, Epub.
HtmlSaveOptions saveOptions = new HtmlSaveOptions(saveFormat);
{
saveOptions.setProgressCallback(new SavingProgressCallback());
}
try {
doc.save(getArtifactsDir() + MessageFormat.format("HtmlSaveOptions.ProgressCallback.{0}", ext), saveOptions);
}
catch (IllegalStateException exception) {
Assert.assertTrue(exception.getMessage().contains("EstimatedProgress"));
}
}
public static Object[][] progressCallbackDataProvider() throws Exception
{
return new Object[][]
{
{SaveFormat.HTML, "html"},
{SaveFormat.MHTML, "mhtml"},
{SaveFormat.EPUB, "epub"},
};
}
///
/// Saving progress callback. Cancel a document saving after the "MaxDuration" seconds.
///
public static class SavingProgressCallback implements IDocumentSavingCallback
{
///
/// Ctr.
///
public SavingProgressCallback()
{
mSavingStartedAt = new Date();
}
///
/// Callback method which called during document saving.
///
/// Saving arguments.
public void notify(DocumentSavingArgs args)
{
Date canceledAt = new Date();
long diff = canceledAt.getTime() - mSavingStartedAt.getTime();
long ellapsedSeconds = TimeUnit.MILLISECONDS.toSeconds(diff);
if (ellapsedSeconds > MAX_DURATION)
throw new IllegalStateException(MessageFormat.format("EstimatedProgress = {0}; CanceledAt = {1}", args.getEstimatedProgress(), canceledAt));
}
///
/// Date and time when document saving is started.
///
private Date mSavingStartedAt;
///
/// Maximum allowed duration in sec.
///
private static final double MAX_DURATION = 0.01d;
}
Shows how to manage a document while saving to docx.
public void progressCallback(int saveFormat, String ext) throws Exception
{
Document doc = new Document(getMyDir() + "Big document.docx");
// Following formats are supported: Docx, FlatOpc, Docm, Dotm, Dotx.
OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(saveFormat);
{
saveOptions.setProgressCallback(new SavingProgressCallback());
}
try {
doc.save(getArtifactsDir() + MessageFormat.format("OoxmlSaveOptions.ProgressCallback.{0}", ext), saveOptions);
}
catch (IllegalStateException exception) {
Assert.assertTrue(exception.getMessage().contains("EstimatedProgress"));
}
}
public static Object[][] progressCallbackDataProvider() throws Exception
{
return new Object[][]
{
{SaveFormat.DOCX, "docx"},
{SaveFormat.DOCM, "docm"},
{SaveFormat.DOTM, "dotm"},
{SaveFormat.DOTX, "dotx"},
{SaveFormat.FLAT_OPC, "flatopc"},
};
}
///
/// Saving progress callback. Cancel a document saving after the "MaxDuration" seconds.
///
public static class SavingProgressCallback implements IDocumentSavingCallback
{
///
/// Ctr.
///
public SavingProgressCallback()
{
mSavingStartedAt = new Date();
}
///
/// Callback method which called during document saving.
///
/// Saving arguments.
public void notify(DocumentSavingArgs args)
{
Date canceledAt = new Date();
long diff = canceledAt.getTime() - mSavingStartedAt.getTime();
long ellapsedSeconds = TimeUnit.MILLISECONDS.toSeconds(diff);
if (ellapsedSeconds > MAX_DURATION)
throw new IllegalStateException(MessageFormat.format("EstimatedProgress = {0}; CanceledAt = {1}", args.getEstimatedProgress(), canceledAt));
}
///
/// Date and time when document saving is started.
///
private Date mSavingStartedAt;
///
/// Maximum allowed duration in sec.
///
private static final double MAX_DURATION = 0.01d;
}
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | IDocumentSavingCallback | The corresponding IDocumentSavingCallback value. |
setSaveFormat(int value)
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(
"\r\n\t\t" +
"1\r\n\t\t" +
"0\r\n\t\t" +
"1\r\n\t\t" +
"0\r\n\t\t" +
"0\r\n\t\t" +
"1\r\n\t\t" +
"1\r\n\t\t" +
"0\r\n\t\t" +
"11.5606\r\n\t" +
""));
else
Assert.assertTrue(fileContents.contains(
"101" +
"0011" +
"011.5606"));
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The corresponding int value. The value must be one of SaveFormat constants. |
setTempFolder(String value)
public void setTempFolder(String value)
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | The corresponding java.lang.String value. |
setUpdateCreatedTimeProperty(boolean value)
public void setUpdateCreatedTimeProperty(boolean value)
Sets a value determining whether the BuiltInDocumentProperties.getCreatedTime() / BuiltInDocumentProperties.setCreatedTime(java.util.Date) property is updated before saving. Default value is false ;
Examples:
Shows how to update a document’s “CreatedTime” property when saving.
Document doc = new Document();
Calendar calendar = Calendar.getInstance();
calendar.set(2019, 11, 20);
doc.getBuiltInDocumentProperties().setCreatedTime(calendar.getTime());
// This flag determines whether the created time, which is a built-in property, is updated.
// If so, then the date of the document's most recent save operation
// with this SaveOptions object passed as a parameter is used as the created time.
DocSaveOptions saveOptions = new DocSaveOptions();
saveOptions.setUpdateCreatedTimeProperty(isUpdateCreatedTimeProperty);
doc.save(getArtifactsDir() + "DocSaveOptions.UpdateCreatedTimeProperty.docx", saveOptions);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | A value determining whether the BuiltInDocumentProperties.getCreatedTime() / BuiltInDocumentProperties.setCreatedTime(java.util.Date) property is updated before saving. |
setUpdateFields(boolean value)
public void setUpdateFields(boolean value)
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 .
Remarks:
Allows to specify whether to mimic or not MS Word behavior.
Examples:
Shows how to update all the fields in a document immediately before saving it to PDF.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert text with PAGE and NUMPAGES fields. These fields do not display the correct value in real time.
// We will need to manually update them using updating methods such as "Field.Update()", and "Document.UpdateFields()"
// each time we need them to display accurate values.
builder.write("Page ");
builder.insertField("PAGE", "");
builder.write(" of ");
builder.insertField("NUMPAGES", "");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Hello World!");
// Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
// to modify how that method converts the document to .PDF.
PdfSaveOptions options = new PdfSaveOptions();
// Set the "UpdateFields" property to "false" to not update all the fields in a document right before a save operation.
// This is the preferable option if we know that all our fields will be up to date before saving.
// Set the "UpdateFields" property to "true" to iterate through all the document
// fields and update them before we save it as a PDF. This will make sure that all the fields will display
// the most accurate values in the PDF.
options.setUpdateFields(updateFields);
// We can clone PdfSaveOptions objects.
Assert.assertNotSame(options, options.deepClone());
doc.save(getArtifactsDir() + "PdfSaveOptions.UpdateFields.pdf", options);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | A value determining if fields of certain types should be updated before saving the document to a fixed page format. |
setUpdateLastPrintedProperty(boolean value)
public void setUpdateLastPrintedProperty(boolean value)
Sets a value determining whether the BuiltInDocumentProperties.getLastPrinted() / BuiltInDocumentProperties.setLastPrinted(java.util.Date) property is updated before saving.
Examples:
Shows how to update a document’s “Last printed” property when saving.
Document doc = new Document();
Calendar calendar = Calendar.getInstance();
calendar.set(2019, 11, 20);
doc.getBuiltInDocumentProperties().setLastPrinted(calendar.getTime());
// This flag determines whether the last printed date, which is a built-in property, is updated.
// If so, then the date of the document's most recent save operation
// with this SaveOptions object passed as a parameter is used as the print date.
DocSaveOptions saveOptions = new DocSaveOptions();
saveOptions.setUpdateLastPrintedProperty(isUpdateLastPrintedProperty);
// In Microsoft Word 2003, this property can be found via File -> Properties -> Statistics -> Printed.
// It can also be displayed in the document's body by using a PRINTDATE field.
doc.save(getArtifactsDir() + "DocSaveOptions.UpdateLastPrintedProperty.doc", saveOptions);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | A value determining whether the BuiltInDocumentProperties.getLastPrinted() / BuiltInDocumentProperties.setLastPrinted(java.util.Date) property is updated before saving. |
setUpdateLastSavedTimeProperty(boolean value)
public void setUpdateLastSavedTimeProperty(boolean value)
Sets a value determining whether the BuiltInDocumentProperties.getLastSavedTime() / BuiltInDocumentProperties.setLastSavedTime(java.util.Date) property is updated before saving.
Examples:
Shows how to determine whether to preserve the document’s “Last saved time” property when saving.
Document doc = new Document(getMyDir() + "Document.docx");
// When we save the document to an OOXML format, we can create an OoxmlSaveOptions object
// and then pass it to the document's saving method to modify how we save the document.
// Set the "UpdateLastSavedTimeProperty" property to "true" to
// set the output document's "Last saved time" built-in property to the current date/time.
// Set the "UpdateLastSavedTimeProperty" property to "false" to
// preserve the original value of the input document's "Last saved time" built-in property.
OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
saveOptions.setUpdateLastSavedTimeProperty(updateLastSavedTimeProperty);
doc.save(getArtifactsDir() + "OoxmlSaveOptions.LastSavedTime.docx", saveOptions);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | A value determining whether the BuiltInDocumentProperties.getLastSavedTime() / BuiltInDocumentProperties.setLastSavedTime(java.util.Date) property is updated before saving. |
setUseAntiAliasing(boolean value)
public void setUseAntiAliasing(boolean value)
Sets a value determining whether or not to use anti-aliasing for rendering.
Remarks:
The default value is false . When this value is set to true anti-aliasing is used for rendering.
This property is used when the document is exported to the following formats: SaveFormat.TIFF, SaveFormat.PNG, SaveFormat.BMP, SaveFormat.JPEG, SaveFormat.EMF. When the document is exported to the SaveFormat.HTML, SaveFormat.MHTML, SaveFormat.EPUB, SaveFormat.AZW_3 or SaveFormat.MOBI formats this option is used for raster images.
Examples:
Shows how to improve the quality of a rendered document with SaveOptions.
Document doc = new Document(getMyDir() + "Rendering.docx");
DocumentBuilder builder = new DocumentBuilder(doc);
builder.getFont().setSize(60.0);
builder.writeln("Some text.");
SaveOptions options = new ImageSaveOptions(SaveFormat.JPEG);
doc.save(getArtifactsDir() + "Document.ImageSaveOptions.Default.jpg", options);
options.setUseAntiAliasing(true);
options.setUseHighQualityRendering(true);
doc.save(getArtifactsDir() + "Document.ImageSaveOptions.HighQuality.jpg", options);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | A value determining whether or not to use anti-aliasing for rendering. |
setUseHighQualityRendering(boolean value)
public void setUseHighQualityRendering(boolean value)
Sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms.
Remarks:
The default value is false .
This property is used when the document is exported to image formats: SaveFormat.TIFF, SaveFormat.PNG, SaveFormat.BMP, SaveFormat.JPEG, SaveFormat.EMF.
Examples:
Shows how to improve the quality of a rendered document with SaveOptions.
Document doc = new Document(getMyDir() + "Rendering.docx");
DocumentBuilder builder = new DocumentBuilder(doc);
builder.getFont().setSize(60.0);
builder.writeln("Some text.");
SaveOptions options = new ImageSaveOptions(SaveFormat.JPEG);
doc.save(getArtifactsDir() + "Document.ImageSaveOptions.Default.jpg", options);
options.setUseAntiAliasing(true);
options.setUseHighQualityRendering(true);
doc.save(getArtifactsDir() + "Document.ImageSaveOptions.HighQuality.jpg", options);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | A value determining whether or not to use high quality (i.e. |
