com.aspose.words
Class TxtSaveOptions

java.lang.Object
  extended by SaveOptions
      extended by TxtSaveOptionsBase
          extended by com.aspose.words.TxtSaveOptions

public class TxtSaveOptions 
extends TxtSaveOptionsBase

Can be used to specify additional options when saving a document into the SaveFormat.TEXT format.

Constructor Summary
TxtSaveOptions()
          
 
Property Getters/Setters Summary
booleangetAddBidiMarks()
voidsetAddBidiMarks(boolean value)
          

Specifies whether to add bi-directional marks before each BiDi run when exporting in plain text format.

The default value is false.

intgetColorMode()→ inherited from SaveOptions
voidsetColorMode(int value)
           Gets or sets a value determining how colors are rendered. The value of the property is ColorMode integer constant.
java.lang.StringgetDefaultTemplate()→ inherited from SaveOptions
voidsetDefaultTemplate(java.lang.String value)
           Gets or sets path to default template (including filename). Default value for this property is empty string.
intgetDmlEffectsRenderingMode()→ inherited from SaveOptions
voidsetDmlEffectsRenderingMode(int value)
           Gets or sets a value determining how DrawingML effects are rendered. The value of the property is DmlEffectsRenderingMode integer constant.
intgetDmlRenderingMode()→ inherited from SaveOptions
voidsetDmlRenderingMode(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.CharsetgetEncoding()→ inherited from TxtSaveOptionsBase
voidsetEncoding(java.nio.charset.Charset value)
           Specifies the encoding to use when exporting in text formats. Default value is 'UTF-8' Charset.
intgetExportHeadersFootersMode()→ inherited from TxtSaveOptionsBase
voidsetExportHeadersFootersMode(int value)
           Specifies the way headers and footers are exported to the text formats. Default value is TxtExportHeadersFootersMode.PRIMARY_ONLY. The value of the property is TxtExportHeadersFootersMode integer constant.
booleangetForcePageBreaks()→ inherited from TxtSaveOptionsBase
voidsetForcePageBreaks(boolean value)
          

Allows to specify whether the page breaks should be preserved during export.

The default value is false.

TxtListIndentationgetListIndentation()
           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.
booleangetMemoryOptimization()→ inherited from SaveOptions
voidsetMemoryOptimization(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.StringgetParagraphBreak()→ inherited from TxtSaveOptionsBase
voidsetParagraphBreak(java.lang.String value)
           Specifies the string to use as a paragraph break when exporting in text formats.
booleangetPreserveTableLayout()→ inherited from TxtSaveOptionsBase
voidsetPreserveTableLayout(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.
booleangetPrettyFormat()→ inherited from SaveOptions
voidsetPrettyFormat(boolean value)
           When true, pretty formats output where applicable. Default value is false.
intgetSaveFormat()
voidsetSaveFormat(int value)
           Specifies the format in which the document will be saved if this save options object is used. Can only be SaveFormat.TEXT. The value of the property is SaveFormat integer constant.
booleangetSimplifyListLabels()
voidsetSimplifyListLabels(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.StringgetTempFolder()→ inherited from SaveOptions
voidsetTempFolder(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.
booleangetUpdateFields()→ inherited from SaveOptions
voidsetUpdateFields(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.
booleangetUpdateLastSavedTimeProperty()→ inherited from SaveOptions
voidsetUpdateLastSavedTimeProperty(boolean value)
           Gets or sets a value determining whether the BuiltInDocumentProperties.LastSavedTime property is updated before saving.
booleangetUpdateSdtContent()→ inherited from SaveOptions
voidsetUpdateSdtContent(boolean value)
           Gets or sets value determining whether content of StructuredDocumentTag is updated before saving.
booleangetUseAntiAliasing()→ inherited from SaveOptions
voidsetUseAntiAliasing(boolean value)
           Gets or sets a value determining whether or not to use anti-aliasing for rendering.
booleangetUseHighQualityRendering()→ inherited from SaveOptions
voidsetUseHighQualityRendering(boolean value)
           Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms.
 

Constructor Detail

TxtSaveOptions

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(getMyDir() + "Document.docx");
// In Aspose.Words by default this option is set to true unlike Word
TxtSaveOptions saveOptions = new TxtSaveOptions();
saveOptions.setAddBidiMarks(false);

doc.save(getArtifactsDir() + "AddBidiMarks.txt", saveOptions);

getColorMode/setColorMode

→ inherited from SaveOptions
public int getColorMode() / public void setColorMode(int value)
Gets or sets a value determining how colors are rendered. The value of the property is ColorMode integer constant.The default value is ColorMode.NORMAL.

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)
Gets or sets path to default template (including filename). Default value for this property is empty string. If specified, this path is used to load template when Document.AutomaticallyUpdateSyles is true, but Document.AttachedTemplate is empty.

getDmlEffectsRenderingMode/setDmlEffectsRenderingMode

→ inherited from SaveOptions
public int getDmlEffectsRenderingMode() / public void setDmlEffectsRenderingMode(int value)
Gets or sets a value determining how DrawingML effects are rendered. The value of the property is DmlEffectsRenderingMode integer constant. The default value is DmlEffectsRenderingMode.SIMPLIFIED.

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)
Gets or sets a value determining how DrawingML shapes are rendered. The value of the property is DmlRenderingMode integer constant. The default value is DmlRenderingMode.FALLBACK.

This property is used when the document is exported to fixed page formats.

Example:

Shows how to define rendering for DML shapes
Document doc = DocumentHelper.createDocumentFillWithDummyText();

PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
pdfSaveOptions.setDmlRenderingMode(DmlRenderingMode.DRAWING_ML);

doc.save(getArtifactsDir() + "DrawingMl.pdf", pdfSaveOptions);

getEncoding/setEncoding

→ inherited from TxtSaveOptionsBase
public java.nio.charset.Charset getEncoding() / public void setEncoding(java.nio.charset.Charset value)
Specifies the encoding to use when exporting in text formats. Default value is 'UTF-8' Charset.

getExportHeadersFootersMode/setExportHeadersFootersMode

→ inherited from TxtSaveOptionsBase
public int getExportHeadersFootersMode() / public void setExportHeadersFootersMode(int value)
Specifies the way headers and footers are exported to the text formats. Default value is TxtExportHeadersFootersMode.PRIMARY_ONLY. The value of the property is TxtExportHeadersFootersMode integer constant.

Example:

Shows how to specifies the way headers and footers are exported to plain text format.
Document doc = new Document(getMyDir() + "HeaderFooter.HeaderFooterOrder.docx");

// 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() + "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.

The property affects only page breaks that are inserted explicitly into a document. It is not related to page breaks that MS Word automatically inserts at the end of each page.

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.txt", saveOptions);

getListIndentation

public 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.

getMemoryOptimization/setMemoryOptimization

→ inherited from SaveOptions
public boolean getMemoryOptimization() / public 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. Setting this option to true can significantly decrease memory consumption while saving large documents at the cost of slower saving time.

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.pdf", saveOptions);

getParagraphBreak/setParagraphBreak

→ inherited from TxtSaveOptionsBase
public java.lang.String getParagraphBreak() / public void setParagraphBreak(java.lang.String value)
Specifies the string to use as a paragraph break when exporting in text formats.

The default value is ControlChar.CR_LF.


getPreserveTableLayout/setPreserveTableLayout

→ inherited from TxtSaveOptionsBase
public boolean getPreserveTableLayout() / public 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.

getPrettyFormat/setPrettyFormat

→ inherited from SaveOptions
public boolean getPrettyFormat() / public void setPrettyFormat(boolean value)
When 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)
Specifies the format in which the document will be saved if this save options object is used. Can only be SaveFormat.TEXT. The value of the property is SaveFormat integer constant.

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)
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.

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 System.OutOfMemoryException. Specifying a temporary folder using TempFolder will cause Aspose.Words to keep the internal structures in temporary files instead of memory. It reduces the memory usage during saving, but will decrease the save performance.

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)
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. Allows to specify whether to mimic or not MS Word behaviour.

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)
Gets or sets a value determining whether the BuiltInDocumentProperties.LastSavedTime property is updated before saving.

Example:

Shows how to update a document time property when you want to save it
Document 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)
Gets or sets value determining whether content of StructuredDocumentTag is updated before saving. The default value is true.

getUseAntiAliasing/setUseAntiAliasing

→ inherited from SaveOptions
public boolean getUseAntiAliasing() / public void setUseAntiAliasing(boolean value)
Gets or sets a value determining whether or not to use anti-aliasing for rendering.

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: SaveFormat.TIFF, SaveFormat.PNG, SaveFormat.BMP, SaveFormat.JPEG, SaveFormat.EMF. When the document is exported to the SaveFormat.HTML, SaveFormat.MHTML and SaveFormat.EPUB formats this option is used for raster images.


getUseHighQualityRendering/setUseHighQualityRendering

→ inherited from SaveOptions
public boolean getUseHighQualityRendering() / public void setUseHighQualityRendering(boolean value)
Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms. The default value is false.

This property is used when the document is exported to image formats: SaveFormat.TIFF, SaveFormat.PNG, SaveFormat.BMP, SaveFormat.JPEG, SaveFormat.EMF.


See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.