public class DocSaveOptions
At the moment provides only the Example:
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.write("Hello world!");
DocSaveOptions options = new DocSaveOptions(SaveFormat.DOC);
// Set a password which will protect the loading of the document by Microsoft Word or Aspose.Words.
// Note that this does not encrypt the contents of the document in any way.
options.setPassword("MyPassword");
// If the document contains a routing slip, we can preserve it while saving by setting this flag to true.
options.setSaveRoutingSlip(true);
doc.save(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc", options);
// To be able to load the document,
// we will need to apply the password we specified in the DocSaveOptions object in a LoadOptions object.
Assert.assertThrows(IncorrectPasswordException.class, () -> new Document(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc"));
LoadOptions loadOptions = new LoadOptions("MyPassword");
doc = new Document(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc", loadOptions);
Assert.assertEquals("Hello world!", doc.getText().trim());
Constructor Summary |
---|
DocSaveOptions()
Initializes a new instance of this class that can be used to save a document in the |
DocSaveOptions(intsaveFormat)
Initializes a new instance of this class that can be used to save a document in the |
Property Getters/Setters Summary | ||
---|---|---|
boolean | getAllowEmbeddingPostScriptFonts() | |
void | setAllowEmbeddingPostScriptFonts(booleanvalue) | |
Gets or 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. | ||
boolean | getAlwaysCompressMetafiles() | |
void | setAlwaysCompressMetafiles(booleanvalue) | |
When false , small metafiles are not compressed for performance reason.
Default value is true, all metafiles are compressed regardless of its size.
|
||
java.lang.String | getDefaultTemplate() | |
void | setDefaultTemplate(java.lang.Stringvalue) | |
Gets or sets path to default template (including filename). Default value for this property is empty string. | ||
int | getDml3DEffectsRenderingMode() | |
void | setDml3DEffectsRenderingMode(intvalue) | |
Gets or sets a value determining how 3D effects are rendered. The value of the property is Dml3DEffectsRenderingMode integer constant. | ||
int | getDmlEffectsRenderingMode() | |
void | setDmlEffectsRenderingMode(intvalue) | |
Gets or sets a value determining how DrawingML effects are rendered. The value of the property is DmlEffectsRenderingMode integer constant. | ||
int | getDmlRenderingMode() | |
void | setDmlRenderingMode(intvalue) | |
Gets or sets a value determining how DrawingML shapes are rendered. The value of the property is DmlRenderingMode integer constant. | ||
boolean | getMemoryOptimization() | |
void | setMemoryOptimization(booleanvalue) | |
Gets or sets value determining if memory optimization should be performed before saving the document. Default value for this property is false. | ||
java.lang.String | getPassword() | |
void | setPassword(java.lang.Stringvalue) | |
Gets/sets a password to encrypt document using RC4 encryption method. | ||
boolean | getPrettyFormat() | |
void | setPrettyFormat(booleanvalue) | |
When true , pretty formats output where applicable.
Default value is false.
|
||
int | getSaveFormat() | |
void | setSaveFormat(intvalue) | |
Specifies the format in which the document will be saved if this save options object is used.
Can be |
||
boolean | getSavePictureBullet() | |
void | setSavePictureBullet(booleanvalue) | |
When false , PictureBullet data is not saved to output document.
Default value is true.
|
||
boolean | getSaveRoutingSlip() | |
void | setSaveRoutingSlip(booleanvalue) | |
When false , RoutingSlip data is not saved to output document.
Default value is true.
|
||
java.lang.String | getTempFolder() | |
void | setTempFolder(java.lang.Stringvalue) | |
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.
|
||
boolean | getUpdateCreatedTimeProperty() | |
void | setUpdateCreatedTimeProperty(booleanvalue) | |
Gets or sets a value determining whether the |
||
boolean | getUpdateFields() | |
void | setUpdateFields(booleanvalue) | |
Gets or sets a value determining if fields of certain types should be updated before saving the document to a fixed page format. Default value for this property is true. | ||
boolean | getUpdateLastPrintedProperty() | |
void | setUpdateLastPrintedProperty(booleanvalue) | |
Gets or sets a value determining whether the |
||
boolean | getUpdateLastSavedTimeProperty() | |
void | setUpdateLastSavedTimeProperty(booleanvalue) | |
Gets or sets a value determining whether the |
||
boolean | getUpdateSdtContent() | |
void | setUpdateSdtContent(booleanvalue) | |
Gets or sets value determining whether content of |
||
boolean | getUseAntiAliasing() | |
void | setUseAntiAliasing(booleanvalue) | |
Gets or sets a value determining whether or not to use anti-aliasing for rendering. | ||
boolean | getUseHighQualityRendering() | |
void | setUseHighQualityRendering(booleanvalue) | |
Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms. |
public DocSaveOptions()
Example:
Shows how to set save options for older Microsoft Word formats.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.write("Hello world!"); DocSaveOptions options = new DocSaveOptions(SaveFormat.DOC); // Set a password which will protect the loading of the document by Microsoft Word or Aspose.Words. // Note that this does not encrypt the contents of the document in any way. options.setPassword("MyPassword"); // If the document contains a routing slip, we can preserve it while saving by setting this flag to true. options.setSaveRoutingSlip(true); doc.save(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc", options); // To be able to load the document, // we will need to apply the password we specified in the DocSaveOptions object in a LoadOptions object. Assert.assertThrows(IncorrectPasswordException.class, () -> new Document(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc")); LoadOptions loadOptions = new LoadOptions("MyPassword"); doc = new Document(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc", loadOptions); Assert.assertEquals("Hello world!", doc.getText().trim());
public DocSaveOptions(int saveFormat)
saveFormat
- A Example:
Shows how to set save options for older Microsoft Word formats.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.write("Hello world!"); DocSaveOptions options = new DocSaveOptions(SaveFormat.DOC); // Set a password which will protect the loading of the document by Microsoft Word or Aspose.Words. // Note that this does not encrypt the contents of the document in any way. options.setPassword("MyPassword"); // If the document contains a routing slip, we can preserve it while saving by setting this flag to true. options.setSaveRoutingSlip(true); doc.save(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc", options); // To be able to load the document, // we will need to apply the password we specified in the DocSaveOptions object in a LoadOptions object. Assert.assertThrows(IncorrectPasswordException.class, () -> new Document(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc")); LoadOptions loadOptions = new LoadOptions("MyPassword"); doc = new Document(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc", loadOptions); Assert.assertEquals("Hello world!", doc.getText().trim());
public boolean getAllowEmbeddingPostScriptFonts() / public void setAllowEmbeddingPostScriptFonts(boolean value)
Note, Word does not embed PostScript fonts, but can open documents with embedded fonts of this type.
This option only works when true
.
Example:
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);
public boolean getAlwaysCompressMetafiles() / public void setAlwaysCompressMetafiles(boolean value)
false
, small metafiles are not compressed for performance reason.
Default value is true, all metafiles are compressed regardless of its size.
Example:
Shows how to change metafiles compression in a document while saving.// Open a document that contains a Microsoft Equation 3.0 formula. Document doc = new Document(getMyDir() + "Microsoft equation object.docx"); // When we save a document, smaller metafiles are not compressed for performance reasons. // We can set a flag in a SaveOptions object to compress every metafile when saving. // Some editors such as LibreOffice cannot read uncompressed metafiles. DocSaveOptions saveOptions = new DocSaveOptions(); saveOptions.setAlwaysCompressMetafiles(compressAllMetafiles); doc.save(getArtifactsDir() + "DocSaveOptions.AlwaysCompressMetafiles.docx", saveOptions);
public java.lang.String getDefaultTemplate() / public void setDefaultTemplate(java.lang.String value)
Example:
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);
public int getDml3DEffectsRenderingMode() / public void setDml3DEffectsRenderingMode(int value)
public int getDmlEffectsRenderingMode() / public void setDmlEffectsRenderingMode(int value)
This property is used when the document is exported to fixed page formats.
Example:
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);
public int getDmlRenderingMode() / public void setDmlRenderingMode(int value)
This property is used when the document is exported to fixed page formats.
Example:
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);
Example:
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);
public boolean getMemoryOptimization() / public void setMemoryOptimization(boolean value)
Example:
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);
public java.lang.String getPassword() / public void setPassword(java.lang.String value)
In order to save document without encryption this property should be null or empty string.
Example:
Shows how to set save options for older Microsoft Word formats.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.write("Hello world!"); DocSaveOptions options = new DocSaveOptions(SaveFormat.DOC); // Set a password which will protect the loading of the document by Microsoft Word or Aspose.Words. // Note that this does not encrypt the contents of the document in any way. options.setPassword("MyPassword"); // If the document contains a routing slip, we can preserve it while saving by setting this flag to true. options.setSaveRoutingSlip(true); doc.save(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc", options); // To be able to load the document, // we will need to apply the password we specified in the DocSaveOptions object in a LoadOptions object. Assert.assertThrows(IncorrectPasswordException.class, () -> new Document(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc")); LoadOptions loadOptions = new LoadOptions("MyPassword"); doc = new Document(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc", loadOptions); Assert.assertEquals("Hello world!", doc.getText().trim());
public boolean getPrettyFormat() / public void setPrettyFormat(boolean value)
true
, pretty formats output where applicable.
Default value is false.
Set to true to make HTML, MHTML, EPUB, WordML, RTF, DOCX and ODT output human readable. Useful for testing or debugging.
Example:
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( "<html>\r\n" + "\t<head>\r\n" + "\t\t<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\r\n" + "\t\t<meta http-equiv=\"Content-Style-Type\" content=\"text/css\" />\r\n" + MessageFormat.format("\t\t<meta name=\"generator\" content=\"{0} {1}\" />\r\n", BuildVersionInfo.getProduct(), BuildVersionInfo.getVersion()) + "\t\t<title>\r\n" + "\t\t</title>\r\n" + "\t</head>\r\n" + "\t<body style=\"font-family:'Times New Roman'; font-size:12pt\">\r\n" + "\t\t<div>\r\n" + "\t\t\t<p style=\"margin-top:0pt; margin-bottom:0pt\">\r\n" + "\t\t\t\t<span>Hello world!</span>\r\n" + "\t\t\t</p>\r\n" + "\t\t\t<p style=\"margin-top:0pt; margin-bottom:0pt\">\r\n" + "\t\t\t\t<span style=\"-aw-import:ignore\"> </span>\r\n" + "\t\t\t</p>\r\n" + "\t\t</div>\r\n" + "\t</body>\r\n</html>", html); else Assert.assertEquals( "<html><head><meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />" + "<meta http-equiv=\"Content-Style-Type\" content=\"text/css\" />" + MessageFormat.format("<meta name=\"generator\" content=\"{0} {1}\" /><title></title></head>", BuildVersionInfo.getProduct(), BuildVersionInfo.getVersion()) + "<body style=\"font-family:'Times New Roman'; font-size:12pt\">" + "<div><p style=\"margin-top:0pt; margin-bottom:0pt\"><span>Hello world!</span></p>" + "<p style=\"margin-top:0pt; margin-bottom:0pt\"><span style=\"-aw-import:ignore\"> </span></p></div></body></html>", html);
public int getSaveFormat() / public void setSaveFormat(int value)
Example:
Shows how to set save options for older Microsoft Word formats.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.write("Hello world!"); DocSaveOptions options = new DocSaveOptions(SaveFormat.DOC); // Set a password which will protect the loading of the document by Microsoft Word or Aspose.Words. // Note that this does not encrypt the contents of the document in any way. options.setPassword("MyPassword"); // If the document contains a routing slip, we can preserve it while saving by setting this flag to true. options.setSaveRoutingSlip(true); doc.save(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc", options); // To be able to load the document, // we will need to apply the password we specified in the DocSaveOptions object in a LoadOptions object. Assert.assertThrows(IncorrectPasswordException.class, () -> new Document(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc")); LoadOptions loadOptions = new LoadOptions("MyPassword"); doc = new Document(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc", loadOptions); Assert.assertEquals("Hello world!", doc.getText().trim());
public boolean getSavePictureBullet() / public void setSavePictureBullet(boolean value)
false
, PictureBullet data is not saved to output document.
Default value is true.
This option is provided for Word 97, which cannot work correctly with PictureBullet data. To remove PictureBullet data, set the option to "false".
Example:
Shows how to omit PictureBullet data from the document when saving.Document doc = new Document(getMyDir() + "Image bullet points.docx"); // Some word processors, such as Microsoft Word 97, are incompatible with PictureBullet data. // By setting a flag in the SaveOptions object, // we can convert all image bullet points to ordinary bullet points while saving. DocSaveOptions saveOptions = new DocSaveOptions(SaveFormat.DOC); saveOptions.setSavePictureBullet(false); doc.save(getArtifactsDir() + "DocSaveOptions.PictureBullets.doc", saveOptions);
public boolean getSaveRoutingSlip() / public void setSaveRoutingSlip(boolean value)
false
, RoutingSlip data is not saved to output document.
Default value is true.
Example:
Shows how to set save options for older Microsoft Word formats.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.write("Hello world!"); DocSaveOptions options = new DocSaveOptions(SaveFormat.DOC); // Set a password which will protect the loading of the document by Microsoft Word or Aspose.Words. // Note that this does not encrypt the contents of the document in any way. options.setPassword("MyPassword"); // If the document contains a routing slip, we can preserve it while saving by setting this flag to true. options.setSaveRoutingSlip(true); doc.save(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc", options); // To be able to load the document, // we will need to apply the password we specified in the DocSaveOptions object in a LoadOptions object. Assert.assertThrows(IncorrectPasswordException.class, () -> new Document(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc")); LoadOptions loadOptions = new LoadOptions("MyPassword"); doc = new Document(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc", loadOptions); Assert.assertEquals("Hello world!", doc.getText().trim());
public java.lang.String getTempFolder() / public void setTempFolder(java.lang.String value)
null
and no temporary files are used.
When Aspose.Words saves a document, it needs to create temporary internal structures. By default, these internal structures are created in memory and the memory usage spikes for a short period while the document is being saved. When saving is complete, the memory is freed and reclaimed by the garbage collector.
If you are saving a very large document (thousands of pages) and/or processing many documents at the same time,
then the memory spike during saving can be significant enough to cause the system to throw
The folder must exist and be writable, otherwise an exception will be thrown.
Aspose.Words automatically deletes all temporary files when saving is complete.
Example:
Shows how to use the hard drive instead of memory when saving a document.Document doc = new Document(getMyDir() + "Rendering.docx"); // When we save a document, various elements are temporarily stored in memory as the save operation is taking place. // We can use this option to use a temporary folder in the local file system instead, // which will reduce our application's memory overhead. DocSaveOptions options = new DocSaveOptions(); options.setTempFolder(getArtifactsDir() + "TempFiles"); // The specified temporary folder must exist in the local file system before the save operation. new File(options.getTempFolder()).mkdir(); doc.save(getArtifactsDir() + "DocSaveOptions.TempFolder.doc", options); // The folder will persist with no residual contents from the load operation. Assert.assertEquals(new File(options.getTempFolder()).listFiles().length, 0);
public boolean getUpdateCreatedTimeProperty() / public void setUpdateCreatedTimeProperty(boolean value)
public boolean getUpdateFields() / public void setUpdateFields(boolean value)
Example:
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);
public boolean getUpdateLastPrintedProperty() / public void setUpdateLastPrintedProperty(boolean value)
Example:
Shows how to update a document's "Last printed" property when saving.Document doc = new Document(); // 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); // Open the saved document, then verify the value of the property. doc = new Document(getArtifactsDir() + "DocSaveOptions.UpdateLastPrintedProperty.doc"); Assert.assertNotEquals(Calendar.getInstance().getTime(), doc.getBuiltInDocumentProperties().getLastPrinted());
public boolean getUpdateLastSavedTimeProperty() / public void setUpdateLastSavedTimeProperty(boolean value)
Example:
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);
public boolean getUpdateSdtContent() / public void setUpdateSdtContent(boolean value)
true
.
Example:
Shows how to update structured document tags while saving a document to PDF.Document doc = new Document(); // Insert a drop-down list structured document tag. StructuredDocumentTag tag = new StructuredDocumentTag(doc, SdtType.DROP_DOWN_LIST, MarkupLevel.BLOCK); tag.getListItems().add(new SdtListItem("Value 1")); tag.getListItems().add(new SdtListItem("Value 2")); tag.getListItems().add(new SdtListItem("Value 3")); // The drop-down list currently displays "Choose an item" as the default text. // Set the "SelectedValue" property to one of the list items to get the tag to // display that list item's value instead of the default text. tag.getListItems().setSelectedValue(tag.getListItems().get(1)); doc.getFirstSection().getBody().appendChild(tag); // Create a "PdfSaveOptions" object to pass to the document's "Save" method // to modify how that method saves the document to .PDF. PdfSaveOptions options = new PdfSaveOptions(); // Set the "UpdateSdtContent" property to "false" not to update the structured document tags // while saving the document to PDF. They will display their default values as they were at the time of construction. // Set the "UpdateSdtContent" property to "true" to make sure the tags display updated values in the PDF. options.setUpdateSdtContent(updateSdtContent); doc.save(getArtifactsDir() + "StructuredDocumentTag.UpdateSdtContent.pdf", options);
public boolean getUseAntiAliasing() / public void setUseAntiAliasing(boolean value)
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:
Example:
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);
public boolean getUseHighQualityRendering() / public void setUseHighQualityRendering(boolean value)
false
.
This property is used when the document is exported to image formats:
Example:
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);