java.lang.ObjectSaveOptions
TxtSaveOptionsBase
com.aspose.words.TxtSaveOptions
public class TxtSaveOptions
Example:
// Create a new document and add some paragraphs
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.writeln("Paragraph 1.");
builder.writeln("Paragraph 2.");
builder.write("Paragraph 3.");
// When saved to plain text, the paragraphs we created can be separated by a custom string
TxtSaveOptions txtSaveOptions = new TxtSaveOptions();
{
txtSaveOptions.setSaveFormat(SaveFormat.TEXT);
txtSaveOptions.setParagraphBreak(" End of paragraph.\n\n\t");
}
doc.save(getArtifactsDir() + "TxtSaveOptions.ParagraphBreak.txt", txtSaveOptions);
Constructor Summary |
---|
TxtSaveOptions()
|
Property Getters/Setters Summary | ||
---|---|---|
boolean | getAddBidiMarks() | |
void | setAddBidiMarks(boolean value) | |
Specifies whether to add bi-directional marks before each BiDi run when exporting in plain text format. The default value is false. |
||
boolean | getAllowEmbeddingPostScriptFonts() | → inherited from SaveOptions |
void | setAllowEmbeddingPostScriptFonts(boolean value) | |
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. | ||
java.lang.String | getDefaultTemplate() | → inherited from SaveOptions |
void | setDefaultTemplate(java.lang.String value) | |
Gets or sets path to default template (including filename). Default value for this property is empty string. | ||
int | getDml3DEffectsRenderingMode() | → inherited from SaveOptions |
void | setDml3DEffectsRenderingMode(int value) | |
Gets or sets a value determining how 3D effects are rendered. The value of the property is Dml3DEffectsRenderingMode integer constant. | ||
int | getDmlEffectsRenderingMode() | → inherited from SaveOptions |
void | setDmlEffectsRenderingMode(int value) | |
Gets or sets a value determining how DrawingML effects are rendered. The value of the property is DmlEffectsRenderingMode integer constant. | ||
int | getDmlRenderingMode() | → inherited from SaveOptions |
void | setDmlRenderingMode(int value) | |
Gets or sets a value determining how DrawingML shapes are rendered. The value of the property is DmlRenderingMode integer constant. | ||
java.nio.charset.Charset | getEncoding() | → inherited from TxtSaveOptionsBase |
void | setEncoding(java.nio.charset.Charset value) | |
Specifies the encoding to use when exporting in text formats. Default value is 'UTF-8' Charset. | ||
int | getExportHeadersFootersMode() | → inherited from TxtSaveOptionsBase |
void | setExportHeadersFootersMode(int value) | |
Specifies the way headers and footers are exported to the text formats.
Default value is |
||
boolean | getForcePageBreaks() | → inherited from TxtSaveOptionsBase |
void | setForcePageBreaks(boolean value) | |
Allows to specify whether the page breaks should be preserved during export. The default value is false. |
||
TxtListIndentation | getListIndentation() | |
Gets a ListIndentation object that specifies how many and which character to use for indentation of list levels. By default it is zero count of character '\0', that means no indentation. | ||
boolean | getMemoryOptimization() | → inherited from SaveOptions |
void | setMemoryOptimization(boolean value) | |
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 | getParagraphBreak() | → inherited from TxtSaveOptionsBase |
void | setParagraphBreak(java.lang.String value) | |
Specifies the string to use as a paragraph break when exporting in text formats. | ||
boolean | getPreserveTableLayout() | |
void | setPreserveTableLayout(boolean value) | |
Specifies whether the program should attempt to preserve layout of tables when saving in the plain text format. The default value is false. | ||
boolean | getPrettyFormat() | → inherited from SaveOptions |
void | setPrettyFormat(boolean value) | |
When true , pretty formats output where applicable.
Default value is false.
|
||
int | getSaveFormat() | |
void | setSaveFormat(int value) | |
Specifies the format in which the document will be saved if this save options object is used.
Can only be |
||
boolean | getSimplifyListLabels() | |
void | setSimplifyListLabels(boolean value) | |
Specifies whether the program should simplify list labels in case of complex label formatting not being adequately represented by plain text. If set to true, numbered list labels are written in simple numeric format and itemized list labels as simple ASCII characters. The default value is false. |
||
java.lang.String | getTempFolder() | → inherited from SaveOptions |
void | setTempFolder(java.lang.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.
|
||
boolean | getUpdateFields() | → inherited from SaveOptions |
void | setUpdateFields(boolean value) | |
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() | → inherited from SaveOptions |
void | setUpdateLastPrintedProperty(boolean value) | |
Gets or sets a value determining whether the |
||
boolean | getUpdateLastSavedTimeProperty() | → inherited from SaveOptions |
void | setUpdateLastSavedTimeProperty(boolean value) | |
Gets or sets a value determining whether the |
||
boolean | getUpdateSdtContent() | → inherited from SaveOptions |
void | setUpdateSdtContent(boolean value) | |
Gets or sets value determining whether content of |
||
boolean | getUseAntiAliasing() | → inherited from SaveOptions |
void | setUseAntiAliasing(boolean value) | |
Gets or sets a value determining whether or not to use anti-aliasing for rendering. | ||
boolean | getUseHighQualityRendering() | → inherited from SaveOptions |
void | setUseHighQualityRendering(boolean value) | |
Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms. |
Constructor Detail |
---|
public TxtSaveOptions()
Property Getters/Setters Detail |
---|
getAddBidiMarks/setAddBidiMarks | |
public boolean getAddBidiMarks() / public void setAddBidiMarks(boolean value) |
Specifies whether to add bi-directional marks before each BiDi run when exporting in plain text format.
The default value is false.
Example:
Shows how to insert Unicode Character 'RIGHT-TO-LEFT MARK' (U+200F) before each bi-directional Run in text.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.writeln("Hello world!"); builder.getParagraphFormat().setBidi(true); builder.writeln("שלום עולם!"); builder.writeln("مرحبا بالعالم!"); TxtSaveOptions saveOptions = new TxtSaveOptions(); { saveOptions.setAddBidiMarks(addBidiMarks); saveOptions.setEncoding(Charset.defaultCharset()); } doc.save(getArtifactsDir() + "TxtSaveOptions.AddBidiMarks.txt", saveOptions);
getAllowEmbeddingPostScriptFonts/setAllowEmbeddingPostScriptFonts | → inherited from SaveOptions |
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
.
getDefaultTemplate/setDefaultTemplate | → inherited from 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);
getDml3DEffectsRenderingMode/setDml3DEffectsRenderingMode | → inherited from SaveOptions |
public int getDml3DEffectsRenderingMode() / public void setDml3DEffectsRenderingMode(int value) |
getDmlEffectsRenderingMode/setDmlEffectsRenderingMode | → inherited from SaveOptions |
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);
getDmlRenderingMode/setDmlRenderingMode | → inherited from SaveOptions |
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);
getEncoding/setEncoding | → inherited from TxtSaveOptionsBase |
public java.nio.charset.Charset getEncoding() / public void setEncoding(java.nio.charset.Charset value) |
Example:
Shows how to set encoding for a .txt output document.// Create a new document and add some text from outside the ASCII character set Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.write("À È Ì Ò Ù."); // We can use a SaveOptions object to make sure the encoding we save the .txt document in supports our content TxtSaveOptions txtSaveOptions = new TxtSaveOptions(); { txtSaveOptions.setEncoding(StandardCharsets.UTF_8); } doc.save(getArtifactsDir() + "TxtSaveOptions.Encoding.txt", txtSaveOptions);
getExportHeadersFootersMode/setExportHeadersFootersMode | → inherited from TxtSaveOptionsBase |
public int getExportHeadersFootersMode() / public void setExportHeadersFootersMode(int value) |
Example:
Shows how to specifies the way headers and footers are exported to plain text format.Document doc = new Document(); // Insert even and primary headers/footers into the document // The primary header/footers should override the even ones doc.getFirstSection().getHeadersFooters().add(new HeaderFooter(doc, HeaderFooterType.HEADER_EVEN)); doc.getFirstSection().getHeadersFooters().getByHeaderFooterType(HeaderFooterType.HEADER_EVEN).appendParagraph("Even header"); doc.getFirstSection().getHeadersFooters().add(new HeaderFooter(doc, HeaderFooterType.FOOTER_EVEN)); doc.getFirstSection().getHeadersFooters().getByHeaderFooterType(HeaderFooterType.FOOTER_EVEN).appendParagraph("Even footer"); doc.getFirstSection().getHeadersFooters().add(new HeaderFooter(doc, HeaderFooterType.HEADER_PRIMARY)); doc.getFirstSection().getHeadersFooters().getByHeaderFooterType(HeaderFooterType.HEADER_PRIMARY).appendParagraph("Primary header"); doc.getFirstSection().getHeadersFooters().add(new HeaderFooter(doc, HeaderFooterType.FOOTER_PRIMARY)); doc.getFirstSection().getHeadersFooters().getByHeaderFooterType(HeaderFooterType.FOOTER_PRIMARY).appendParagraph("Primary footer"); // Insert pages that would display these headers and footers DocumentBuilder builder = new DocumentBuilder(doc); builder.writeln("Page 1"); builder.insertBreak(BreakType.PAGE_BREAK); builder.writeln("Page 2"); builder.insertBreak(BreakType.PAGE_BREAK); builder.write("Page 3"); // Three values are available in TxtExportHeadersFootersMode enum: // "None" - No headers and footers are exported // "AllAtEnd" - All headers and footers are placed after all section bodies at the very end of a document // "PrimaryOnly" - Only primary headers and footers are exported at the beginning and end of each section (default value) TxtSaveOptions saveOptions = new TxtSaveOptions(); { saveOptions.setExportHeadersFootersMode(txtExportHeadersFootersMode); } doc.save(getArtifactsDir() + "TxtSaveOptions.ExportHeadersFooters.txt", saveOptions);
getForcePageBreaks/setForcePageBreaks | → inherited from TxtSaveOptionsBase |
public boolean getForcePageBreaks() / public void setForcePageBreaks(boolean value) |
Allows to specify whether the page breaks should be preserved during export.
The default value is false.
Example:
Shows how to specify whether the page breaks should be preserved during export.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"); // If ForcePageBreaks is set to true then the output document will have form feed characters in place of page breaks // Otherwise, they will be line breaks TxtSaveOptions saveOptions = new TxtSaveOptions(); { saveOptions.setForcePageBreaks(forcePageBreaks); } doc.save(getArtifactsDir() + "TxtSaveOptions.PageBreaks.txt", saveOptions); // If we load the document using Aspose.Words again, the page breaks will be preserved/lost depending on ForcePageBreaks doc = new Document(getArtifactsDir() + "TxtSaveOptions.PageBreaks.txt"); Assert.assertEquals(forcePageBreaks ? 3 : 1, doc.getPageCount());
getListIndentation | |
public TxtListIndentation getListIndentation() |
Example:
Shows how to configure list indenting when converting to plaintext.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Create a list with three levels of indentation builder.getListFormat().applyNumberDefault(); builder.writeln("Item 1"); builder.getListFormat().listIndent(); builder.writeln("Item 2"); builder.getListFormat().listIndent(); builder.write("Item 3"); // Microsoft Word list objects get lost when converting to plaintext // We can create a custom representation for list indentation using pure plaintext with a SaveOptions object // In this case, each list item will be left-padded by 3 space characters times its list indent level TxtSaveOptions txtSaveOptions = new TxtSaveOptions(); txtSaveOptions.getListIndentation().setCount(3); txtSaveOptions.getListIndentation().setCharacter(' '); doc.save(getArtifactsDir() + "TxtSaveOptions.TxtListIndentation.txt", txtSaveOptions);
getMemoryOptimization/setMemoryOptimization | → inherited from SaveOptions |
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);
getParagraphBreak/setParagraphBreak | → inherited from TxtSaveOptionsBase |
public java.lang.String getParagraphBreak() / public void setParagraphBreak(java.lang.String value) |
The default value is
Example:
Shows how to save a .txt document with a custom paragraph break.// Create a new document and add some paragraphs Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.writeln("Paragraph 1."); builder.writeln("Paragraph 2."); builder.write("Paragraph 3."); // When saved to plain text, the paragraphs we created can be separated by a custom string TxtSaveOptions txtSaveOptions = new TxtSaveOptions(); { txtSaveOptions.setSaveFormat(SaveFormat.TEXT); txtSaveOptions.setParagraphBreak(" End of paragraph.\n\n\t"); } doc.save(getArtifactsDir() + "TxtSaveOptions.ParagraphBreak.txt", txtSaveOptions);
getPreserveTableLayout/setPreserveTableLayout | |
public boolean getPreserveTableLayout() / public void setPreserveTableLayout(boolean value) |
Example:
Shows how to preserve the layout of tables when converting to plaintext.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a table builder.startTable(); builder.insertCell(); builder.write("Row 1, cell 1"); builder.insertCell(); builder.write("Row 1, cell 2"); builder.endRow(); builder.insertCell(); builder.write("Row 2, cell 1"); builder.insertCell(); builder.write("Row 2, cell 2"); builder.endTable(); // Tables, with their borders and widths do not translate to plaintext // However, we can configure a SaveOptions object to arrange table contents to preserve some of the table's appearance TxtSaveOptions txtSaveOptions = new TxtSaveOptions(); { txtSaveOptions.setPreserveTableLayout(preserveTableLayout); } doc.save(getArtifactsDir() + "TxtSaveOptions.TableLayout.txt", txtSaveOptions);
getPrettyFormat/setPrettyFormat | → inherited from SaveOptions |
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);
getSaveFormat/setSaveFormat | |
public int getSaveFormat() / public void setSaveFormat(int value) |
Example:
Shows how to save a .txt document with a custom paragraph break.// Create a new document and add some paragraphs Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.writeln("Paragraph 1."); builder.writeln("Paragraph 2."); builder.write("Paragraph 3."); // When saved to plain text, the paragraphs we created can be separated by a custom string TxtSaveOptions txtSaveOptions = new TxtSaveOptions(); { txtSaveOptions.setSaveFormat(SaveFormat.TEXT); txtSaveOptions.setParagraphBreak(" End of paragraph.\n\n\t"); } doc.save(getArtifactsDir() + "TxtSaveOptions.ParagraphBreak.txt", txtSaveOptions);
getSimplifyListLabels/setSimplifyListLabels | |
public boolean getSimplifyListLabels() / public void setSimplifyListLabels(boolean value) |
Specifies whether the program should simplify list labels in case of complex label formatting not being adequately represented by plain text.
If set to true, numbered list labels are written in simple numeric format and itemized list labels as simple ASCII characters. The default value is false.
Example:
Shows how to change the appearance of lists when converting to plaintext.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Create a bulleted list with five levels of indentation builder.getListFormat().applyBulletDefault(); builder.writeln("Item 1"); builder.getListFormat().listIndent(); builder.writeln("Item 2"); builder.getListFormat().listIndent(); builder.writeln("Item 3"); builder.getListFormat().listIndent(); builder.writeln("Item 4"); builder.getListFormat().listIndent(); builder.write("Item 5"); // The SimplifyListLabels flag will convert some list symbols // into ASCII characters such as *, o, +, > etc, depending on list level TxtSaveOptions txtSaveOptions = new TxtSaveOptions(); { txtSaveOptions.setSimplifyListLabels(simplifyListLabels); } doc.save(getArtifactsDir() + "TxtSaveOptions.SimplifyListLabels.txt", txtSaveOptions);
getTempFolder/setTempFolder | → inherited from SaveOptions |
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);
getUpdateFields/setUpdateFields | → inherited from SaveOptions |
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);
getUpdateLastPrintedProperty/setUpdateLastPrintedProperty | → inherited from SaveOptions |
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());
getUpdateLastSavedTimeProperty/setUpdateLastSavedTimeProperty | → inherited from SaveOptions |
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);
getUpdateSdtContent/setUpdateSdtContent | → inherited from SaveOptions |
public boolean getUpdateSdtContent() / public void setUpdateSdtContent(boolean value) |
true
.
Example:
Shows how structured document tags can be updated while saving to .pdf.Document doc = new Document(); // Insert two StructuredDocumentTags; a date and a drop down list StructuredDocumentTag tag = new StructuredDocumentTag(doc, SdtType.DATE, MarkupLevel.BLOCK); tag.setFullDate(new Date()); doc.getFirstSection().getBody().appendChild(tag); 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")); tag.getListItems().setSelectedValue(tag.getListItems().get(1)); doc.getFirstSection().getBody().appendChild(tag); // We've selected default values for both tags // We can save those values in the document without immediately updating the tags, leaving them in their default state // by using a SaveOptions object with this flag set PdfSaveOptions options = new PdfSaveOptions(); options.setUpdateSdtContent(updateSdtContent); doc.save(getArtifactsDir() + "StructuredDocumentTag.UpdateSdtContent.pdf", options);
getUseAntiAliasing/setUseAntiAliasing | → inherited from SaveOptions |
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);
getUseHighQualityRendering/setUseHighQualityRendering | → inherited from SaveOptions |
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);