XpsSaveOptions
Inheritance: java.lang.Object, com.aspose.words.SaveOptions, com.aspose.words.FixedPageSaveOptions
public class XpsSaveOptions extends FixedPageSaveOptions
Can be used to specify additional options when saving a document into the SaveFormat.XPS format.
To learn more, visit the Specify Save Options documentation article.
Examples:
Shows how to limit the headings’ level that will appear in the outline of a saved XPS document.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert headings that can serve as TOC entries of levels 1, 2, and then 3.
builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_1);
Assert.assertTrue(builder.getParagraphFormat().isHeading());
builder.writeln("Heading 1");
builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_2);
builder.writeln("Heading 1.1");
builder.writeln("Heading 1.2");
builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_3);
builder.writeln("Heading 1.2.1");
builder.writeln("Heading 1.2.2");
// Create an "XpsSaveOptions" object that we can pass to the document's "Save" method
// to modify how that method converts the document to .XPS.
XpsSaveOptions saveOptions = new XpsSaveOptions();
Assert.assertEquals(SaveFormat.XPS, saveOptions.getSaveFormat());
// The output XPS document will contain an outline, a table of contents that lists headings in the document body.
// Clicking on an entry in this outline will take us to the location of its respective heading.
// Set the "HeadingsOutlineLevels" property to "2" to exclude all headings whose levels are above 2 from the outline.
// The last two headings we have inserted above will not appear.
saveOptions.getOutlineOptions().setHeadingsOutlineLevels(2);
doc.save(getArtifactsDir() + "XpsSaveOptions.OutlineLevels.xps", saveOptions);
Constructors
| Constructor | Description |
|---|---|
| XpsSaveOptions() | Initializes a new instance of this class that can be used to save a document in the SaveFormat.XPS format. |
| XpsSaveOptions(int saveFormat) | Initializes a new instance of this class. |
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. |
| equals(Object obj) | Determines whether the specified object is equal in value to the current object. |
| 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. |
| getColorMode() | Gets a value determining how colors are rendered. |
| getDefaultTemplate() | Gets path to default template (including filename). |
| getDigitalSignatureDetails() | Gets DigitalSignatureDetails object used to sign a document. |
| 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. |
| getJpegQuality() | Gets a value determining the quality of the JPEG images inside Html document. |
| getMemoryOptimization() | Gets value determining if memory optimization should be performed before saving the document. |
| getMetafileRenderingOptions() | Allows to specify metafile rendering options. |
| getNumeralFormat() | Gets NumeralFormat used for rendering of numerals. |
| getOptimizeOutput() | Flag indicates whether it is required to optimize output. |
| getOutlineOptions() | Allows to specify outline options. |
| getPageSavingCallback() | Allows to control how separate pages are saved when a document is exported to fixed page format. |
| getPageSet() | Gets the pages to render. |
| 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. |
| getUseBookFoldPrintingSettings() | Gets a boolean value indicating whether the document should be saved using a booklet printing layout, if it is specified via PageSetup.getMultiplePages() / PageSetup.setMultiplePages(int). |
| 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. |
| setColorMode(int value) | Sets a value determining how colors are rendered. |
| setDefaultTemplate(String value) | Sets path to default template (including filename). |
| setDigitalSignatureDetails(DigitalSignatureDetails value) | Sets DigitalSignatureDetails object used to sign a document. |
| 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. |
| setJpegQuality(int value) | Sets a value determining the quality of the JPEG images inside Html document. |
| setMemoryOptimization(boolean value) | Sets value determining if memory optimization should be performed before saving the document. |
| setMetafileRenderingOptions(MetafileRenderingOptions value) | Allows to specify metafile rendering options. |
| setNumeralFormat(int value) | Sets NumeralFormat used for rendering of numerals. |
| setOptimizeOutput(boolean value) | Flag indicates whether it is required to optimize output. |
| setPageSavingCallback(IPageSavingCallback value) | Allows to control how separate pages are saved when a document is exported to fixed page format. |
| setPageSet(PageSet value) | Sets the pages to render. |
| 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. |
| setUseBookFoldPrintingSettings(boolean value) | Sets a boolean value indicating whether the document should be saved using a booklet printing layout, if it is specified via PageSetup.getMultiplePages() / PageSetup.setMultiplePages(int). |
| setUseHighQualityRendering(boolean value) | Sets a value determining whether or not to use high quality (i.e. |
XpsSaveOptions()
public XpsSaveOptions()
Initializes a new instance of this class that can be used to save a document in the SaveFormat.XPS format.
Examples:
Shows how to limit the headings’ level that will appear in the outline of a saved XPS document.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert headings that can serve as TOC entries of levels 1, 2, and then 3.
builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_1);
Assert.assertTrue(builder.getParagraphFormat().isHeading());
builder.writeln("Heading 1");
builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_2);
builder.writeln("Heading 1.1");
builder.writeln("Heading 1.2");
builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_3);
builder.writeln("Heading 1.2.1");
builder.writeln("Heading 1.2.2");
// Create an "XpsSaveOptions" object that we can pass to the document's "Save" method
// to modify how that method converts the document to .XPS.
XpsSaveOptions saveOptions = new XpsSaveOptions();
Assert.assertEquals(SaveFormat.XPS, saveOptions.getSaveFormat());
// The output XPS document will contain an outline, a table of contents that lists headings in the document body.
// Clicking on an entry in this outline will take us to the location of its respective heading.
// Set the "HeadingsOutlineLevels" property to "2" to exclude all headings whose levels are above 2 from the outline.
// The last two headings we have inserted above will not appear.
saveOptions.getOutlineOptions().setHeadingsOutlineLevels(2);
doc.save(getArtifactsDir() + "XpsSaveOptions.OutlineLevels.xps", saveOptions);
XpsSaveOptions(int saveFormat)
public XpsSaveOptions(int saveFormat)
Initializes a new instance of this class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| saveFormat | int |
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.
equals(Object obj)
public boolean equals(Object obj)
Determines whether the specified object is equal in value to the current object.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| obj | java.lang.Object |
Returns: boolean
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.
getColorMode()
public int getColorMode()
Gets a value determining how colors are rendered.
Remarks:
The default value is ColorMode.NORMAL.
Examples:
Shows how to change image color with saving options property.
Document doc = new Document(getMyDir() + "Images.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.
// Set the "ColorMode" property to "Grayscale" to render all images from the document in black and white.
// The size of the output document may be larger with this setting.
// Set the "ColorMode" property to "Normal" to render all images in color.
PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
{
pdfSaveOptions.setColorMode(colorMode);
}
doc.save(getArtifactsDir() + "PdfSaveOptions.ColorRendering.pdf", pdfSaveOptions);
Returns: int - A value determining how colors are rendered. The returned value is one of ColorMode constants.
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).
getDigitalSignatureDetails()
public DigitalSignatureDetails getDigitalSignatureDetails()
Gets DigitalSignatureDetails object used to sign a document.
Examples:
Shows how to sign XPS document.
Document doc = new Document(getMyDir() + "Document.docx");
CertificateHolder certificateHolder = CertificateHolder.create(getMyDir() + "morzal.pfx", "aw");
SignOptions signOptions = new SignOptions();
{
signOptions.setComments("My comment");
signOptions.setSignTime(new Date());
}
DigitalSignatureDetails digitalSignatureDetails = new DigitalSignatureDetails(certificateHolder, signOptions);
XpsSaveOptions saveOptions = new XpsSaveOptions();
saveOptions.setDigitalSignatureDetails(digitalSignatureDetails);
Assert.assertEquals(certificateHolder, digitalSignatureDetails.getCertificateHolder());
Assert.assertEquals("My comment", digitalSignatureDetails.getSignOptions().getComments());
doc.save(getArtifactsDir() + "XpsSaveOptions.XpsDigitalSignature.docx", saveOptions);
Returns: DigitalSignatureDetails - DigitalSignatureDetails object used to sign a document.
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.
getJpegQuality()
public int getJpegQuality()
Gets a value determining the quality of the JPEG images inside Html document.
Remarks:
Has effect only when a document contains JPEG images.
Use this property to get or set the quality of the images inside a document when saving in fixed page format. The value may vary from 0 to 100 where 0 means worst quality but maximum compression and 100 means best quality but minimum compression.
The default value is 95.
Examples:
Shows how to configure compression while saving a document as a JPEG.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.insertImage(getImageDir() + "Logo.jpg");
// Create an "ImageSaveOptions" object which we can pass to the document's "Save" method
// to modify the way in which that method renders the document into an image.
ImageSaveOptions imageOptions = new ImageSaveOptions(SaveFormat.JPEG);
// Set the "JpegQuality" property to "10" to use stronger compression when rendering the document.
// This will reduce the file size of the document, but the image will display more prominent compression artifacts.
imageOptions.setJpegQuality(10);
doc.save(getArtifactsDir() + "ImageSaveOptions.JpegQuality.HighCompression.jpg", imageOptions);
Assert.assertTrue(new File(getArtifactsDir() + "ImageSaveOptions.JpegQuality.HighCompression.jpg").length() <= 20000);
// Set the "JpegQuality" property to "100" to use weaker compression when rending the document.
// This will improve the quality of the image at the cost of an increased file size.
imageOptions.setJpegQuality(100);
doc.save(getArtifactsDir() + "ImageSaveOptions.JpegQuality.HighQuality.jpg", imageOptions);
Assert.assertTrue(new File(getArtifactsDir() + "ImageSaveOptions.JpegQuality.HighQuality.jpg").length() < 60000);
Returns: int - A value determining the quality of the JPEG images inside Html document.
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.
getMetafileRenderingOptions()
public MetafileRenderingOptions getMetafileRenderingOptions()
Allows to specify metafile rendering options.
Examples:
Shows added a fallback to bitmap rendering and changing type of warnings about unsupported metafile records.
public void handleBinaryRasterWarnings() throws Exception {
Document doc = new Document(getMyDir() + "WMF with image.docx");
MetafileRenderingOptions metafileRenderingOptions = new MetafileRenderingOptions();
// Set the "EmulateRasterOperations" property to "false" to fall back to bitmap when
// it encounters a metafile, which will require raster operations to render in the output PDF.
metafileRenderingOptions.setEmulateRasterOperations(false);
// Set the "RenderingMode" property to "VectorWithFallback" to try to render every metafile using vector graphics.
metafileRenderingOptions.setRenderingMode(MetafileRenderingMode.VECTOR_WITH_FALLBACK);
// Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
// to modify how that method converts the document to .PDF and applies the configuration
// in our MetafileRenderingOptions object to the saving operation.
PdfSaveOptions saveOptions = new PdfSaveOptions();
saveOptions.setMetafileRenderingOptions(metafileRenderingOptions);
HandleDocumentWarnings callback = new HandleDocumentWarnings();
doc.setWarningCallback(callback);
doc.save(getArtifactsDir() + "PdfSaveOptions.HandleBinaryRasterWarnings.pdf", saveOptions);
Assert.assertEquals(1, callback.mWarnings.getCount());
Assert.assertEquals("'R2_XORPEN' binary raster operation is not supported.",
callback.mWarnings.get(0).getDescription());
}
///
/// Prints and collects formatting loss-related warnings that occur upon saving a document.
///
public static class HandleDocumentWarnings implements IWarningCallback {
public void warning(WarningInfo info) {
if (info.getWarningType() == WarningType.MINOR_FORMATTING_LOSS) {
System.out.println("Unsupported operation: " + info.getDescription());
this.mWarnings.warning(info);
}
}
public WarningInfoCollection mWarnings = new WarningInfoCollection();
}
Returns: MetafileRenderingOptions - The corresponding MetafileRenderingOptions value.
getNumeralFormat()
public int getNumeralFormat()
Gets NumeralFormat used for rendering of numerals. European numerals are used by default.
Remarks:
If the value of this property is changed and page layout is already built then Document.updatePageLayout() is invoked automatically to update any changes.
Examples:
Shows how to set the numeral format used when saving to PDF.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.getFont().setLocaleId(1025);
builder.writeln("1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 50, 100");
// 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 "NumeralFormat" property to "NumeralFormat.ArabicIndic" to
// use glyphs from the U+0660 to U+0669 range as numbers.
// Set the "NumeralFormat" property to "NumeralFormat.Context" to
// look up the locale to determine what number of glyphs to use.
// Set the "NumeralFormat" property to "NumeralFormat.EasternArabicIndic" to
// use glyphs from the U+06F0 to U+06F9 range as numbers.
// Set the "NumeralFormat" property to "NumeralFormat.European" to use european numerals.
// Set the "NumeralFormat" property to "NumeralFormat.System" to determine the symbol set from regional settings.
options.setNumeralFormat(numeralFormat);
doc.save(getArtifactsDir() + "PdfSaveOptions.SetNumeralFormat.pdf", options);
Returns: int - NumeralFormat used for rendering of numerals. The returned value is one of NumeralFormat constants.
getOptimizeOutput()
public boolean getOptimizeOutput()
Flag indicates whether it is required to optimize output. If this flag is set redundant nested canvases and empty canvases are removed, also neighbor glyphs with the same formatting are concatenated. Note: The accuracy of the content display may be affected if this property is set to true . Default is false .
Examples:
Shows how to simplify a document when saving it to HTML by removing various redundant objects.
Document doc = new Document(getMyDir() + "Rendering.docx");
HtmlFixedSaveOptions saveOptions = new HtmlFixedSaveOptions();
{
saveOptions.setOptimizeOutput(optimizeOutput);
}
doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.OptimizeGraphicsOutput.html", saveOptions);
// The size of the optimized version of the document is almost a third of the size of the unoptimized document.
if (optimizeOutput)
Assert.assertEquals(61889.0,
new File(getArtifactsDir() + "HtmlFixedSaveOptions.OptimizeGraphicsOutput.html").length(), 200.0);
else
Assert.assertEquals(191770.0,
new File(getArtifactsDir() + "HtmlFixedSaveOptions.OptimizeGraphicsOutput.html").length(), 200.0);
Shows how to optimize document objects while saving to xps.
Document doc = new Document(getMyDir() + "Unoptimized document.docx");
// Create an "XpsSaveOptions" object to pass to the document's "Save" method
// to modify how that method converts the document to .XPS.
XpsSaveOptions saveOptions = new XpsSaveOptions();
// Set the "OptimizeOutput" property to "true" to take measures such as removing nested or empty canvases
// and concatenating adjacent runs with identical formatting to optimize the output document's content.
// This may affect the appearance of the document.
// Set the "OptimizeOutput" property to "false" to save the document normally.
saveOptions.setOptimizeOutput(optimizeOutput);
doc.save(getArtifactsDir() + "XpsSaveOptions.OptimizeOutput.xps", saveOptions);
Returns: boolean - The corresponding boolean value.
getOutlineOptions()
public OutlineOptions getOutlineOptions()
Allows to specify outline options.
Remarks:
Note that OutlineOptions.getExpandedOutlineLevels() / OutlineOptions.setExpandedOutlineLevels(int) option will not work when saving to XPS.
Examples:
Shows how to limit the headings’ level that will appear in the outline of a saved XPS document.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert headings that can serve as TOC entries of levels 1, 2, and then 3.
builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_1);
Assert.assertTrue(builder.getParagraphFormat().isHeading());
builder.writeln("Heading 1");
builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_2);
builder.writeln("Heading 1.1");
builder.writeln("Heading 1.2");
builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_3);
builder.writeln("Heading 1.2.1");
builder.writeln("Heading 1.2.2");
// Create an "XpsSaveOptions" object that we can pass to the document's "Save" method
// to modify how that method converts the document to .XPS.
XpsSaveOptions saveOptions = new XpsSaveOptions();
Assert.assertEquals(SaveFormat.XPS, saveOptions.getSaveFormat());
// The output XPS document will contain an outline, a table of contents that lists headings in the document body.
// Clicking on an entry in this outline will take us to the location of its respective heading.
// Set the "HeadingsOutlineLevels" property to "2" to exclude all headings whose levels are above 2 from the outline.
// The last two headings we have inserted above will not appear.
saveOptions.getOutlineOptions().setHeadingsOutlineLevels(2);
doc.save(getArtifactsDir() + "XpsSaveOptions.OutlineLevels.xps", saveOptions);
Returns: OutlineOptions - The corresponding OutlineOptions value.
getPageSavingCallback()
public IPageSavingCallback getPageSavingCallback()
Allows to control how separate pages are saved when a document is exported to fixed page format.
Examples:
Shows how to use a callback to save a document to HTML page by page.
public void pageFileNames() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.writeln("Page 1.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Page 2.");
builder.insertImage(getImageDir() + "Logo.jpg");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Page 3.");
// Create an "HtmlFixedSaveOptions" object, which we can pass to the document's "Save" method
// to modify how we convert the document to HTML.
HtmlFixedSaveOptions htmlFixedSaveOptions = new HtmlFixedSaveOptions();
// We will save each page in this document to a separate HTML file in the local file system.
// Set a callback that allows us to name each output HTML document.
htmlFixedSaveOptions.setPageSavingCallback(new CustomFileNamePageSavingCallback());
doc.save(getArtifactsDir() + "SavingCallback.PageFileNames.html", htmlFixedSaveOptions);
String[] filePaths = DocumentHelper.directoryGetFiles(getArtifactsDir(), "SavingCallback.PageFileNames.Page_*").toArray(new String[0]);
Assert.assertEquals(3, filePaths.length);
}
///
/// Saves all pages to a file and directory specified within.
///
private static class CustomFileNamePageSavingCallback implements IPageSavingCallback {
public void pageSaving(PageSavingArgs args) throws Exception {
String outFileName = MessageFormat.format("{0}SavingCallback.PageFileNames.Page_{1}.html", getArtifactsDir(), args.getPageIndex());
// Below are two ways of specifying where Aspose.Words will save each page of the document.
// 1 - Set a filename for the output page file:
args.setPageFileName(outFileName);
// 2 - Create a custom stream for the output page file:
try (FileOutputStream outputStream = new FileOutputStream(outFileName)) {
args.setPageStream(outputStream);
}
Assert.assertFalse(args.getKeepPageStreamOpen());
}
}
Returns: IPageSavingCallback - The corresponding IPageSavingCallback value.
getPageSet()
public PageSet getPageSet()
Gets the pages to render. Default is all the pages in the document.
Examples:
Shows how to extract pages based on exact page indices.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Add five pages to the document.
for (int i = 1; i < 6; i++) {
builder.write("Page " + i);
builder.insertBreak(BreakType.PAGE_BREAK);
}
// Create an "XpsSaveOptions" object, which we can pass to the document's "Save" method
// to modify how that method converts the document to .XPS.
XpsSaveOptions xpsOptions = new XpsSaveOptions();
// Use the "PageSet" property to select a set of the document's pages to save to output XPS.
// In this case, we will choose, via a zero-based index, only three pages: page 1, page 2, and page 4.
xpsOptions.setPageSet(new PageSet(0, 1, 3));
doc.save(getArtifactsDir() + "XpsSaveOptions.ExportExactPages.xps", xpsOptions);
Shows how to convert only some of the pages in a document to PDF.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.writeln("Page 1.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Page 2.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Page 3.");
// 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 "PageIndex" to "1" to render a portion of the document starting from the second page.
options.setPageSet(new PageSet(1));
// This document will contain one page starting from page two, which will only contain the second page.
doc.save(new FileOutputStream(getArtifactsDir() + "PdfSaveOptions.OnePage.pdf"), options);
Shows how to export Odd pages from the document.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
for (int i = 0; i < 5; i++) {
builder.writeln(MessageFormat.format("Page {0} ({1})", i + 1, (i % 2 == 0 ? "odd" : "even")));
if (i < 4)
builder.insertBreak(BreakType.PAGE_BREAK);
}
// 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();
// Below are three PageSet properties that we can use to filter out a set of pages from
// our document to save in an output PDF document based on the parity of their page numbers.
// 1 - Save only the even-numbered pages:
options.setPageSet(PageSet.getEven());
doc.save(getArtifactsDir() + "PdfSaveOptions.ExportPageSet.Even.pdf", options);
// 2 - Save only the odd-numbered pages:
options.setPageSet(PageSet.getOdd());
doc.save(getArtifactsDir() + "PdfSaveOptions.ExportPageSet.Odd.pdf", options);
// 3 - Save every page:
options.setPageSet(PageSet.getAll());
doc.save(getArtifactsDir() + "PdfSaveOptions.ExportPageSet.All.pdf", options);
Returns: PageSet - The pages to render.
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.XPS.
Examples:
Shows how to limit the headings’ level that will appear in the outline of a saved XPS document.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert headings that can serve as TOC entries of levels 1, 2, and then 3.
builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_1);
Assert.assertTrue(builder.getParagraphFormat().isHeading());
builder.writeln("Heading 1");
builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_2);
builder.writeln("Heading 1.1");
builder.writeln("Heading 1.2");
builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_3);
builder.writeln("Heading 1.2.1");
builder.writeln("Heading 1.2.2");
// Create an "XpsSaveOptions" object that we can pass to the document's "Save" method
// to modify how that method converts the document to .XPS.
XpsSaveOptions saveOptions = new XpsSaveOptions();
Assert.assertEquals(SaveFormat.XPS, saveOptions.getSaveFormat());
// The output XPS document will contain an outline, a table of contents that lists headings in the document body.
// Clicking on an entry in this outline will take us to the location of its respective heading.
// Set the "HeadingsOutlineLevels" property to "2" to exclude all headings whose levels are above 2 from the outline.
// The last two headings we have inserted above will not appear.
saveOptions.getOutlineOptions().setHeadingsOutlineLevels(2);
doc.save(getArtifactsDir() + "XpsSaveOptions.OutlineLevels.xps", saveOptions);
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.
getUseBookFoldPrintingSettings()
public boolean getUseBookFoldPrintingSettings()
Gets a boolean value indicating whether the document should be saved using a booklet printing layout, if it is specified via PageSetup.getMultiplePages() / PageSetup.setMultiplePages(int).
Remarks:
If this option is specified, FixedPageSaveOptions.getPageSet() / FixedPageSaveOptions.setPageSet(com.aspose.words.PageSet) is ignored when saving. This behavior matches MS Word. If book fold printing settings are not specified in page setup, this option will have no effect.
Examples:
Shows how to save a document to the XPS format in the form of a book fold.
Document doc = new Document(getMyDir() + "Paragraphs.docx");
// Create an "XpsSaveOptions" object that we can pass to the document's "Save" method
// to modify how that method converts the document to .XPS.
XpsSaveOptions xpsOptions = new XpsSaveOptions(SaveFormat.XPS);
// Set the "UseBookFoldPrintingSettings" property to "true" to arrange the contents
// in the output XPS in a way that helps us use it to make a booklet.
// Set the "UseBookFoldPrintingSettings" property to "false" to render the XPS normally.
xpsOptions.setUseBookFoldPrintingSettings(renderTextAsBookFold);
// If we are rendering the document as a booklet, we must set the "MultiplePages"
// properties of the page setup objects of all sections to "MultiplePagesType.BookFoldPrinting".
if (renderTextAsBookFold)
for (Section s : doc.getSections()) {
s.getPageSetup().setMultiplePages(MultiplePagesType.BOOK_FOLD_PRINTING);
}
// Once we print this document, we can turn it into a booklet by stacking the pages
// to come out of the printer and folding down the middle.
doc.save(getArtifactsDir() + "XpsSaveOptions.BookFold.xps", xpsOptions);
Returns: boolean - A boolean value indicating whether the document should be saved using a booklet printing layout, if it is specified via PageSetup.getMultiplePages() / PageSetup.setMultiplePages(int).
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. |
setColorMode(int value)
public void setColorMode(int value)
Sets a value determining how colors are rendered.
Remarks:
The default value is ColorMode.NORMAL.
Examples:
Shows how to change image color with saving options property.
Document doc = new Document(getMyDir() + "Images.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.
// Set the "ColorMode" property to "Grayscale" to render all images from the document in black and white.
// The size of the output document may be larger with this setting.
// Set the "ColorMode" property to "Normal" to render all images in color.
PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
{
pdfSaveOptions.setColorMode(colorMode);
}
doc.save(getArtifactsDir() + "PdfSaveOptions.ColorRendering.pdf", pdfSaveOptions);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | A value determining how colors are rendered. The value must be one of ColorMode constants. |
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). |
setDigitalSignatureDetails(DigitalSignatureDetails value)
public void setDigitalSignatureDetails(DigitalSignatureDetails value)
Sets DigitalSignatureDetails object used to sign a document.
Examples:
Shows how to sign XPS document.
Document doc = new Document(getMyDir() + "Document.docx");
CertificateHolder certificateHolder = CertificateHolder.create(getMyDir() + "morzal.pfx", "aw");
SignOptions signOptions = new SignOptions();
{
signOptions.setComments("My comment");
signOptions.setSignTime(new Date());
}
DigitalSignatureDetails digitalSignatureDetails = new DigitalSignatureDetails(certificateHolder, signOptions);
XpsSaveOptions saveOptions = new XpsSaveOptions();
saveOptions.setDigitalSignatureDetails(digitalSignatureDetails);
Assert.assertEquals(certificateHolder, digitalSignatureDetails.getCertificateHolder());
Assert.assertEquals("My comment", digitalSignatureDetails.getSignOptions().getComments());
doc.save(getArtifactsDir() + "XpsSaveOptions.XpsDigitalSignature.docx", saveOptions);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | DigitalSignatureDetails | DigitalSignatureDetails object used to sign a document. |
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. |
setJpegQuality(int value)
public void setJpegQuality(int value)
Sets a value determining the quality of the JPEG images inside Html document.
Remarks:
Has effect only when a document contains JPEG images.
Use this property to get or set the quality of the images inside a document when saving in fixed page format. The value may vary from 0 to 100 where 0 means worst quality but maximum compression and 100 means best quality but minimum compression.
The default value is 95.
Examples:
Shows how to configure compression while saving a document as a JPEG.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.insertImage(getImageDir() + "Logo.jpg");
// Create an "ImageSaveOptions" object which we can pass to the document's "Save" method
// to modify the way in which that method renders the document into an image.
ImageSaveOptions imageOptions = new ImageSaveOptions(SaveFormat.JPEG);
// Set the "JpegQuality" property to "10" to use stronger compression when rendering the document.
// This will reduce the file size of the document, but the image will display more prominent compression artifacts.
imageOptions.setJpegQuality(10);
doc.save(getArtifactsDir() + "ImageSaveOptions.JpegQuality.HighCompression.jpg", imageOptions);
Assert.assertTrue(new File(getArtifactsDir() + "ImageSaveOptions.JpegQuality.HighCompression.jpg").length() <= 20000);
// Set the "JpegQuality" property to "100" to use weaker compression when rending the document.
// This will improve the quality of the image at the cost of an increased file size.
imageOptions.setJpegQuality(100);
doc.save(getArtifactsDir() + "ImageSaveOptions.JpegQuality.HighQuality.jpg", imageOptions);
Assert.assertTrue(new File(getArtifactsDir() + "ImageSaveOptions.JpegQuality.HighQuality.jpg").length() < 60000);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | A value determining the quality of the JPEG images inside Html document. |
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. |
setMetafileRenderingOptions(MetafileRenderingOptions value)
public void setMetafileRenderingOptions(MetafileRenderingOptions value)
Allows to specify metafile rendering options.
Examples:
Shows added a fallback to bitmap rendering and changing type of warnings about unsupported metafile records.
public void handleBinaryRasterWarnings() throws Exception {
Document doc = new Document(getMyDir() + "WMF with image.docx");
MetafileRenderingOptions metafileRenderingOptions = new MetafileRenderingOptions();
// Set the "EmulateRasterOperations" property to "false" to fall back to bitmap when
// it encounters a metafile, which will require raster operations to render in the output PDF.
metafileRenderingOptions.setEmulateRasterOperations(false);
// Set the "RenderingMode" property to "VectorWithFallback" to try to render every metafile using vector graphics.
metafileRenderingOptions.setRenderingMode(MetafileRenderingMode.VECTOR_WITH_FALLBACK);
// Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
// to modify how that method converts the document to .PDF and applies the configuration
// in our MetafileRenderingOptions object to the saving operation.
PdfSaveOptions saveOptions = new PdfSaveOptions();
saveOptions.setMetafileRenderingOptions(metafileRenderingOptions);
HandleDocumentWarnings callback = new HandleDocumentWarnings();
doc.setWarningCallback(callback);
doc.save(getArtifactsDir() + "PdfSaveOptions.HandleBinaryRasterWarnings.pdf", saveOptions);
Assert.assertEquals(1, callback.mWarnings.getCount());
Assert.assertEquals("'R2_XORPEN' binary raster operation is not supported.",
callback.mWarnings.get(0).getDescription());
}
///
/// Prints and collects formatting loss-related warnings that occur upon saving a document.
///
public static class HandleDocumentWarnings implements IWarningCallback {
public void warning(WarningInfo info) {
if (info.getWarningType() == WarningType.MINOR_FORMATTING_LOSS) {
System.out.println("Unsupported operation: " + info.getDescription());
this.mWarnings.warning(info);
}
}
public WarningInfoCollection mWarnings = new WarningInfoCollection();
}
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | MetafileRenderingOptions | The corresponding MetafileRenderingOptions value. |
setNumeralFormat(int value)
public void setNumeralFormat(int value)
Sets NumeralFormat used for rendering of numerals. European numerals are used by default.
Remarks:
If the value of this property is changed and page layout is already built then Document.updatePageLayout() is invoked automatically to update any changes.
Examples:
Shows how to set the numeral format used when saving to PDF.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.getFont().setLocaleId(1025);
builder.writeln("1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 50, 100");
// 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 "NumeralFormat" property to "NumeralFormat.ArabicIndic" to
// use glyphs from the U+0660 to U+0669 range as numbers.
// Set the "NumeralFormat" property to "NumeralFormat.Context" to
// look up the locale to determine what number of glyphs to use.
// Set the "NumeralFormat" property to "NumeralFormat.EasternArabicIndic" to
// use glyphs from the U+06F0 to U+06F9 range as numbers.
// Set the "NumeralFormat" property to "NumeralFormat.European" to use european numerals.
// Set the "NumeralFormat" property to "NumeralFormat.System" to determine the symbol set from regional settings.
options.setNumeralFormat(numeralFormat);
doc.save(getArtifactsDir() + "PdfSaveOptions.SetNumeralFormat.pdf", options);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | NumeralFormat used for rendering of numerals. The value must be one of NumeralFormat constants. |
setOptimizeOutput(boolean value)
public void setOptimizeOutput(boolean value)
Flag indicates whether it is required to optimize output. If this flag is set redundant nested canvases and empty canvases are removed, also neighbor glyphs with the same formatting are concatenated. Note: The accuracy of the content display may be affected if this property is set to true . Default is false .
Examples:
Shows how to simplify a document when saving it to HTML by removing various redundant objects.
Document doc = new Document(getMyDir() + "Rendering.docx");
HtmlFixedSaveOptions saveOptions = new HtmlFixedSaveOptions();
{
saveOptions.setOptimizeOutput(optimizeOutput);
}
doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.OptimizeGraphicsOutput.html", saveOptions);
// The size of the optimized version of the document is almost a third of the size of the unoptimized document.
if (optimizeOutput)
Assert.assertEquals(61889.0,
new File(getArtifactsDir() + "HtmlFixedSaveOptions.OptimizeGraphicsOutput.html").length(), 200.0);
else
Assert.assertEquals(191770.0,
new File(getArtifactsDir() + "HtmlFixedSaveOptions.OptimizeGraphicsOutput.html").length(), 200.0);
Shows how to optimize document objects while saving to xps.
Document doc = new Document(getMyDir() + "Unoptimized document.docx");
// Create an "XpsSaveOptions" object to pass to the document's "Save" method
// to modify how that method converts the document to .XPS.
XpsSaveOptions saveOptions = new XpsSaveOptions();
// Set the "OptimizeOutput" property to "true" to take measures such as removing nested or empty canvases
// and concatenating adjacent runs with identical formatting to optimize the output document's content.
// This may affect the appearance of the document.
// Set the "OptimizeOutput" property to "false" to save the document normally.
saveOptions.setOptimizeOutput(optimizeOutput);
doc.save(getArtifactsDir() + "XpsSaveOptions.OptimizeOutput.xps", saveOptions);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The corresponding boolean value. |
setPageSavingCallback(IPageSavingCallback value)
public void setPageSavingCallback(IPageSavingCallback value)
Allows to control how separate pages are saved when a document is exported to fixed page format.
Examples:
Shows how to use a callback to save a document to HTML page by page.
public void pageFileNames() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.writeln("Page 1.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Page 2.");
builder.insertImage(getImageDir() + "Logo.jpg");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Page 3.");
// Create an "HtmlFixedSaveOptions" object, which we can pass to the document's "Save" method
// to modify how we convert the document to HTML.
HtmlFixedSaveOptions htmlFixedSaveOptions = new HtmlFixedSaveOptions();
// We will save each page in this document to a separate HTML file in the local file system.
// Set a callback that allows us to name each output HTML document.
htmlFixedSaveOptions.setPageSavingCallback(new CustomFileNamePageSavingCallback());
doc.save(getArtifactsDir() + "SavingCallback.PageFileNames.html", htmlFixedSaveOptions);
String[] filePaths = DocumentHelper.directoryGetFiles(getArtifactsDir(), "SavingCallback.PageFileNames.Page_*").toArray(new String[0]);
Assert.assertEquals(3, filePaths.length);
}
///
/// Saves all pages to a file and directory specified within.
///
private static class CustomFileNamePageSavingCallback implements IPageSavingCallback {
public void pageSaving(PageSavingArgs args) throws Exception {
String outFileName = MessageFormat.format("{0}SavingCallback.PageFileNames.Page_{1}.html", getArtifactsDir(), args.getPageIndex());
// Below are two ways of specifying where Aspose.Words will save each page of the document.
// 1 - Set a filename for the output page file:
args.setPageFileName(outFileName);
// 2 - Create a custom stream for the output page file:
try (FileOutputStream outputStream = new FileOutputStream(outFileName)) {
args.setPageStream(outputStream);
}
Assert.assertFalse(args.getKeepPageStreamOpen());
}
}
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | IPageSavingCallback | The corresponding IPageSavingCallback value. |
setPageSet(PageSet value)
public void setPageSet(PageSet value)
Sets the pages to render. Default is all the pages in the document.
Examples:
Shows how to extract pages based on exact page indices.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Add five pages to the document.
for (int i = 1; i < 6; i++) {
builder.write("Page " + i);
builder.insertBreak(BreakType.PAGE_BREAK);
}
// Create an "XpsSaveOptions" object, which we can pass to the document's "Save" method
// to modify how that method converts the document to .XPS.
XpsSaveOptions xpsOptions = new XpsSaveOptions();
// Use the "PageSet" property to select a set of the document's pages to save to output XPS.
// In this case, we will choose, via a zero-based index, only three pages: page 1, page 2, and page 4.
xpsOptions.setPageSet(new PageSet(0, 1, 3));
doc.save(getArtifactsDir() + "XpsSaveOptions.ExportExactPages.xps", xpsOptions);
Shows how to convert only some of the pages in a document to PDF.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.writeln("Page 1.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Page 2.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Page 3.");
// 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 "PageIndex" to "1" to render a portion of the document starting from the second page.
options.setPageSet(new PageSet(1));
// This document will contain one page starting from page two, which will only contain the second page.
doc.save(new FileOutputStream(getArtifactsDir() + "PdfSaveOptions.OnePage.pdf"), options);
Shows how to export Odd pages from the document.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
for (int i = 0; i < 5; i++) {
builder.writeln(MessageFormat.format("Page {0} ({1})", i + 1, (i % 2 == 0 ? "odd" : "even")));
if (i < 4)
builder.insertBreak(BreakType.PAGE_BREAK);
}
// 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();
// Below are three PageSet properties that we can use to filter out a set of pages from
// our document to save in an output PDF document based on the parity of their page numbers.
// 1 - Save only the even-numbered pages:
options.setPageSet(PageSet.getEven());
doc.save(getArtifactsDir() + "PdfSaveOptions.ExportPageSet.Even.pdf", options);
// 2 - Save only the odd-numbered pages:
options.setPageSet(PageSet.getOdd());
doc.save(getArtifactsDir() + "PdfSaveOptions.ExportPageSet.Odd.pdf", options);
// 3 - Save every page:
options.setPageSet(PageSet.getAll());
doc.save(getArtifactsDir() + "PdfSaveOptions.ExportPageSet.All.pdf", options);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | PageSet | The pages to render. |
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.XPS.
Examples:
Shows how to limit the headings’ level that will appear in the outline of a saved XPS document.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert headings that can serve as TOC entries of levels 1, 2, and then 3.
builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_1);
Assert.assertTrue(builder.getParagraphFormat().isHeading());
builder.writeln("Heading 1");
builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_2);
builder.writeln("Heading 1.1");
builder.writeln("Heading 1.2");
builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_3);
builder.writeln("Heading 1.2.1");
builder.writeln("Heading 1.2.2");
// Create an "XpsSaveOptions" object that we can pass to the document's "Save" method
// to modify how that method converts the document to .XPS.
XpsSaveOptions saveOptions = new XpsSaveOptions();
Assert.assertEquals(SaveFormat.XPS, saveOptions.getSaveFormat());
// The output XPS document will contain an outline, a table of contents that lists headings in the document body.
// Clicking on an entry in this outline will take us to the location of its respective heading.
// Set the "HeadingsOutlineLevels" property to "2" to exclude all headings whose levels are above 2 from the outline.
// The last two headings we have inserted above will not appear.
saveOptions.getOutlineOptions().setHeadingsOutlineLevels(2);
doc.save(getArtifactsDir() + "XpsSaveOptions.OutlineLevels.xps", saveOptions);
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. |
setUseBookFoldPrintingSettings(boolean value)
public void setUseBookFoldPrintingSettings(boolean value)
Sets a boolean value indicating whether the document should be saved using a booklet printing layout, if it is specified via PageSetup.getMultiplePages() / PageSetup.setMultiplePages(int).
Remarks:
If this option is specified, FixedPageSaveOptions.getPageSet() / FixedPageSaveOptions.setPageSet(com.aspose.words.PageSet) is ignored when saving. This behavior matches MS Word. If book fold printing settings are not specified in page setup, this option will have no effect.
Examples:
Shows how to save a document to the XPS format in the form of a book fold.
Document doc = new Document(getMyDir() + "Paragraphs.docx");
// Create an "XpsSaveOptions" object that we can pass to the document's "Save" method
// to modify how that method converts the document to .XPS.
XpsSaveOptions xpsOptions = new XpsSaveOptions(SaveFormat.XPS);
// Set the "UseBookFoldPrintingSettings" property to "true" to arrange the contents
// in the output XPS in a way that helps us use it to make a booklet.
// Set the "UseBookFoldPrintingSettings" property to "false" to render the XPS normally.
xpsOptions.setUseBookFoldPrintingSettings(renderTextAsBookFold);
// If we are rendering the document as a booklet, we must set the "MultiplePages"
// properties of the page setup objects of all sections to "MultiplePagesType.BookFoldPrinting".
if (renderTextAsBookFold)
for (Section s : doc.getSections()) {
s.getPageSetup().setMultiplePages(MultiplePagesType.BOOK_FOLD_PRINTING);
}
// Once we print this document, we can turn it into a booklet by stacking the pages
// to come out of the printer and folding down the middle.
doc.save(getArtifactsDir() + "XpsSaveOptions.BookFold.xps", xpsOptions);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | A boolean value indicating whether the document should be saved using a booklet printing layout, if it is specified via PageSetup.getMultiplePages() / PageSetup.setMultiplePages(int). |
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. |
