java.lang.ObjectSaveOptions
com.aspose.words.TxtSaveOptions
public class TxtSaveOptions
Constructor Summary |
---|
TxtSaveOptions()
Initializes a new instance of this class that can be used to save a document in the |
Property Getters/Setters Summary | ||
---|---|---|
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. | ||
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. | ||
boolean | getExportHeadersFooters() | |
void | setExportHeadersFooters(boolean value) | |
Specifies whether to output headers and footers when exporting in plain text format. Default value is true. | ||
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 | 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. | ||
IWarningCallback | getWarningCallback() | → inherited from SaveOptions |
void | setWarningCallback(IWarningCallback value) | |
Called during a save operation, when an issue is detected that might result in data or formatting fidelity loss. |
Constructor Detail |
---|
public TxtSaveOptions()
Property Getters/Setters Detail |
---|
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.
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.
getEncoding/setEncoding | |
public java.nio.charset.Charset getEncoding() / public void setEncoding(java.nio.charset.Charset value) |
getExportHeadersFooters/setExportHeadersFooters | |
public boolean getExportHeadersFooters() / public void setExportHeadersFooters(boolean value) |
It is hard to meaningfully output headers and footers to plain text because it is not paginated. When this property is true, Aspose.Words exports only primary headers and footers at the beginning and end of each section. You can disable export of headers and footers altogether by setting this property to false.
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(getMyDir() + "Document.PrettyFormat Out.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.
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:
getWarningCallback/setWarningCallback | → inherited from SaveOptions |
public IWarningCallback getWarningCallback() / public void setWarningCallback(IWarningCallback value) |
This property is obsolete. Please use
Example:
Demonstrates how to implement the IWarningCallback to be notified of any font substitution during document save.public class HandleDocumentWarnings implements IWarningCallback { /** * Our callback only needs to implement the "Warning" method. This method is called whenever there is a * potential issue during document procssing. The callback can be set to listen for warnings generated during document * load and/or document save. */ public void warning(WarningInfo info) { // We are only interested in fonts being substituted. if (info.getWarningType() == WarningType.FONT_SUBSTITUTION) { System.out.println("Font substitution: " + info.getDescription()); } } }
Example:
Demonstrates how to recieve notifications of font substitutions by using IWarningCallback.// Load the document to render. Document doc = new Document(getMyDir() + "Document.doc"); // We can choose the default font to use in the case of any missing fonts. FontSettings.setDefaultFontName("Arial"); // For testing we will set Aspose.Words to look for fonts only in a folder which doesn't exist. Since Aspose.Words won't // find any fonts in the specified directory, then during rendering the fonts in the document will be subsuited with the default // font specified under FontSettings.DefaultFontName. We can pick up on this subsuition using our callback. FontSettings.setFontsFolder("", false); // Create a new class implementing IWarningCallback which collect any warnings produced during document save. HandleDocumentWarnings callback = new HandleDocumentWarnings(); // We assign the callback to the appropriate save options class. In this case, we are going to save to PDF // so we create a PdfSaveOptions class and assign the callback there. PdfSaveOptions saveOptions = new PdfSaveOptions(); saveOptions.setWarningCallback(callback); // Pass the save options along with the save path to the save method. doc.save(getMyDir() + "Rendering.MissingFontNotification Out.pdf", saveOptions);