java.lang.ObjectSaveOptions
com.aspose.words.TxtSaveOptions
public class 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. |
||
int | getColorMode() | → inherited from SaveOptions |
void | setColorMode(int value) | |
Gets or sets a value determining how colors are rendered. The value of the property is ColorMode integer constant. | ||
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 | 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() | |
void | setEncoding(java.nio.charset.Charset value) | |
Specifies the encoding to use when exporting in plain text format. Default value is 'UTF-8' Charset. | ||
int | getExportHeadersFootersMode() | |
void | setExportHeadersFootersMode(int value) | |
Specifies the way headers and footers are exported to the plain text format.
Default value is |
||
boolean | getForcePageBreaks() | |
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() | |
void | setParagraphBreak(java.lang.String value) | |
Specifies the string to use as a paragraph break when exporting in plain text format. | ||
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 | 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.
getColorMode/setColorMode | → inherited from SaveOptions |
public int getColorMode() / public void setColorMode(int value) |
This property is used when the document is exported to fixed page formats.
Example:
Shows how change image color with save options property// Open document with color image Document doc = new Document(getMyDir() + "Rendering.doc"); // Set grayscale mode for document PdfSaveOptions pdfSaveOptions = new PdfSaveOptions(); pdfSaveOptions.setColorMode(ColorMode.GRAYSCALE); // Assert that color image in document was grey doc.save(getArtifactsDir() + "ColorMode.PdfGrayscaleMode.pdf", pdfSaveOptions);
getDefaultTemplate/setDefaultTemplate | → inherited from SaveOptions |
public java.lang.String getDefaultTemplate() / public void setDefaultTemplate(java.lang.String 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.
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 define rendering for DML shapesDocument doc = DocumentHelper.createDocumentFillWithDummyText(); PdfSaveOptions pdfSaveOptions = new PdfSaveOptions(); pdfSaveOptions.setDmlRenderingMode(DmlRenderingMode.DRAWING_ML); doc.save(getArtifactsDir() + "DrawingMl.pdf", pdfSaveOptions);
getEncoding/setEncoding | |
public java.nio.charset.Charset getEncoding() / public void setEncoding(java.nio.charset.Charset value) |
getExportHeadersFootersMode/setExportHeadersFootersMode | |
public int getExportHeadersFootersMode() / public void setExportHeadersFootersMode(int value) |
getForcePageBreaks/setForcePageBreaks | |
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(getMyDir() + "SaveOptions.PageBreaks.docx"); TxtSaveOptions saveOptions = new TxtSaveOptions(); saveOptions.setForcePageBreaks(false); doc.save(getArtifactsDir() + "SaveOptions.PageBreaks.False.txt", saveOptions);
getListIndentation | |
public TxtListIndentation getListIndentation() |
getMemoryOptimization/setMemoryOptimization | → inherited from SaveOptions |
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() + "SaveOptions.MemoryOptimization.doc"); // When set to true it will improve document memory footprint but will add extra time to processing. // This optimization is only applied during save operation. SaveOptions saveOptions = SaveOptions.createSaveOptions(SaveFormat.PDF); saveOptions.setMemoryOptimization(true); doc.save(getArtifactsDir() + "SaveOptions.MemoryOptimization Out.pdf", saveOptions);
getParagraphBreak/setParagraphBreak | |
public java.lang.String getParagraphBreak() / public void setParagraphBreak(java.lang.String value) |
The default value is
getPreserveTableLayout/setPreserveTableLayout | |
public boolean getPreserveTableLayout() / public void setPreserveTableLayout(boolean value) |
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 pass an option to export HTML tags in a well spaced, human readable format.Document doc = new Document(getMyDir() + "Document.doc"); HtmlSaveOptions htmlOptions = new HtmlSaveOptions(SaveFormat.HTML); // Enabling the PrettyFormat setting will export HTML in an indented format that is easy to read. // If this is setting is false (by default) then the HTML tags will be exported in condensed form with no indentation. htmlOptions.setPrettyFormat(true); doc.save(getArtifactsDir() + "Document.PrettyFormat.html", htmlOptions);
getSaveFormat/setSaveFormat | |
public int getSaveFormat() / public void setSaveFormat(int value) |
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.
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.
getUpdateFields/setUpdateFields | → inherited from SaveOptions |
public boolean getUpdateFields() / public void setUpdateFields(boolean value) |
Example:
Shows how to update fields before saving into a PDF document.Document doc = DocumentHelper.createDocumentFillWithDummyText(); PdfSaveOptions pdfSaveOptions = new PdfSaveOptions(); pdfSaveOptions.setUpdateFields(false); doc.save(getArtifactsDir() + "UpdateFields_False.pdf", pdfSaveOptions);
getUpdateLastSavedTimeProperty/setUpdateLastSavedTimeProperty | → inherited from SaveOptions |
public boolean getUpdateLastSavedTimeProperty() / public void setUpdateLastSavedTimeProperty(boolean value) |
Example:
Shows how to update a document time property when you want to save itDocument doc = new Document(getMyDir() + "Document.doc"); //Get last saved time Date documentTimeBeforeSave = doc.getBuiltInDocumentProperties().getLastSavedTime(); OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); saveOptions.setUpdateLastSavedTimeProperty(true);
getUpdateSdtContent/setUpdateSdtContent | → inherited from SaveOptions |
public boolean getUpdateSdtContent() / public void setUpdateSdtContent(boolean value) |
true
.
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:
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: