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 |
---|
Property Getters/Setters Summary | ||
---|---|---|
boolean | getAddBidiMarks() | |
void | setAddBidiMarks(booleanvalue) | |
Specifies whether to add bi-directional marks before each BiDi run when exporting in plain text format. The default value is false. |
||
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. | ||
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. | ||
java.nio.charset.Charset | getEncoding() | |
void | setEncoding(java.nio.charset.Charsetvalue) | |
Specifies the encoding to use when exporting in text formats. Default value is 'UTF-8' Charset. | ||
int | getExportHeadersFootersMode() | |
void | setExportHeadersFootersMode(intvalue) | |
Specifies the way headers and footers are exported to the text formats.
Default value is |
||
boolean | getForcePageBreaks() | |
void | setForcePageBreaks(booleanvalue) | |
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() | |
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 | getParagraphBreak() | |
void | setParagraphBreak(java.lang.Stringvalue) | |
Specifies the string to use as a paragraph break when exporting in text formats. | ||
boolean | getPreserveTableLayout() | |
void | setPreserveTableLayout(booleanvalue) | |
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() | |
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 only be |
||
boolean | getSimplifyListLabels() | |
void | setSimplifyListLabels(booleanvalue) | |
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() | |
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 | 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 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);
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
.
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 DrawingML rendering quality with PdfSaveOptions.Document doc = new Document(getMyDir() + "DrawingML shape effects.docx"); PdfSaveOptions options = new PdfSaveOptions(); 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"); PdfSaveOptions options = new PdfSaveOptions(); options.setDmlRenderingMode(dmlRenderingMode); doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingMLFallback.pdf", options);
Example:
Shows how to configure DrawingML rendering quality with PdfSaveOptions.Document doc = new Document(getMyDir() + "DrawingML shape effects.docx"); PdfSaveOptions options = new PdfSaveOptions(); options.setDmlEffectsRenderingMode(effectsRenderingMode); Assert.assertEquals(DmlRenderingMode.DRAWING_ML, options.getDmlRenderingMode()); doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingMLEffects.pdf", options);
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(Charset.forName("UTF-8")); } doc.save(getArtifactsDir() + "TxtSaveOptions.Encoding.txt", txtSaveOptions);
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);
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());
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);
public boolean getMemoryOptimization() / public void setMemoryOptimization(boolean value)
Example:
Shows an option to optimize memory consumption when you work with large documents.Document doc = new Document(getMyDir() + "Rendering.docx"); // When set to true it will improve document memory footprint but will add extra time to processing SaveOptions saveOptions = SaveOptions.createSaveOptions(SaveFormat.PDF); saveOptions.setMemoryOptimization(true); doc.save(getArtifactsDir() + "PdfSaveOptions.MemoryOptimization.pdf", saveOptions);
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);
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);
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.
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);
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);
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 getUpdateFields() / public void setUpdateFields(boolean value)
Example:
Shows how to update fields before saving into a PDF document.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert two pages of text, including two fields that will need to be updated to display an accurate value builder.write("Page "); builder.insertField("PAGE", ""); builder.write(" of "); builder.insertField("NUMPAGES", ""); builder.insertBreak(BreakType.PAGE_BREAK); builder.writeln("Hello World!"); PdfSaveOptions options = new PdfSaveOptions(); options.setUpdateFields(doUpdateFields); // PdfSaveOptions objects can be cloned 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 update a document time property when you want to save it.Document doc = new Document(getMyDir() + "Document.docx"); // Get last saved time Date documentTimeBeforeSave = doc.getBuiltInDocumentProperties().getLastSavedTime(); OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); saveOptions.setUpdateLastSavedTimeProperty(true); doc.save(getArtifactsDir() + "OoxmlSaveOptions.UpdatingLastSavedTimeDocument.docx", 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);
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);