com.aspose.words

Class TxtSaveOptions

java.lang.Object

com.aspose.words.SaveOptions

com.aspose.words.TxtSaveOptionsBase

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.

To learn more, visit the Specify Save Options documentation article.

Method Summary

Modifier and Type	Method and Description
boolean	getAddBidiMarks() Specifies whether to add bi-directional marks before each BiDi run when exporting in plain text format.
TxtListIndentation	getListIndentation() Gets a ListIndentation object that specifies how many and which character to use for indentation of list levels.
int	getMaxCharactersPerLine() Gets an integer value that specifies the maximum number of characters per one line.
boolean	getPreserveTableLayout() Specifies whether the program should attempt to preserve layout of tables when saving in the plain text format.
int	getSaveFormat() Specifies the format in which the document will be saved if this save options object is used.
boolean	getSimplifyListLabels() Specifies whether the program should simplify list labels in case of complex label formatting not being adequately represented by plain text.
void	setAddBidiMarks(boolean value) Specifies whether to add bi-directional marks before each BiDi run when exporting in plain text format.
void	setMaxCharactersPerLine(int value) Sets an integer value that specifies the maximum number of characters per one line.
void	setPreserveTableLayout(boolean value) Specifies whether the program should attempt to preserve layout of tables when saving in the plain text format.
void	setSaveFormat(int value) Specifies the format in which the document will be saved if this save options object is used.
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.

Methods inherited from class com.aspose.words.TxtSaveOptionsBase

getEncoding, getExportHeadersFootersMode, getForcePageBreaks, getParagraphBreak, setEncoding, setExportHeadersFootersMode, setForcePageBreaks, setParagraphBreak

Methods inherited from class com.aspose.words.SaveOptions

createSaveOptions, createSaveOptions, getAllowEmbeddingPostScriptFonts, getDefaultTemplate, getDml3DEffectsRenderingMode, getDmlEffectsRenderingMode, getDmlRenderingMode, getExportGeneratorName, getImlRenderingMode, getMemoryOptimization, getPrettyFormat, getProgressCallback, getTempFolder, getUpdateCreatedTimeProperty, getUpdateFields, getUpdateLastPrintedProperty, getUpdateLastSavedTimeProperty, getUpdateSdtContent, getUseAntiAliasing, getUseHighQualityRendering, setAllowEmbeddingPostScriptFonts, setDefaultTemplate, setDml3DEffectsRenderingMode, setDmlEffectsRenderingMode, setDmlRenderingMode, setExportGeneratorName, setImlRenderingMode, setMemoryOptimization, setPrettyFormat, setProgressCallback, setTempFolder, setUpdateCreatedTimeProperty, setUpdateFields, setUpdateLastPrintedProperty, setUpdateLastSavedTimeProperty, setUpdateSdtContent, setUseAntiAliasing, setUseHighQualityRendering

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getSaveFormat

public int getSaveFormat()

Specifies the format in which the document will be saved if this save options object is used. Can only be SaveFormat.TEXT.

Specified by:

getSaveFormat in class SaveOptions

Returns:

The corresponding int value. The returned value is one of SaveFormat constants.

setSaveFormat

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.

Specified by:

setSaveFormat in class SaveOptions

Parameters:

value - The corresponding int value. The value must be one of SaveFormat constants.

getSimplifyListLabels

public boolean getSimplifyListLabels()

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.

Returns:

The corresponding boolean value.

setSimplifyListLabels

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.

Parameters:

value - The corresponding boolean value.

getAddBidiMarks

public boolean getAddBidiMarks()

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

The default value is false.

Returns:

The corresponding boolean value.

setAddBidiMarks

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.

Parameters:

value - The corresponding boolean value.

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.

Returns:

A ListIndentation object that specifies how many and which character to use for indentation of list levels.

getPreserveTableLayout

public boolean getPreserveTableLayout()

Specifies whether the program should attempt to preserve layout of tables when saving in the plain text format. The default value is false.

Returns:

The corresponding boolean value.

setPreserveTableLayout

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.

Parameters:

value - The corresponding boolean value.

getMaxCharactersPerLine

public int getMaxCharactersPerLine()

Gets an integer value that specifies the maximum number of characters per one line. The default value is 0, that means no limit.

Returns:

An integer value that specifies the maximum number of characters per one line.

setMaxCharactersPerLine

public void setMaxCharactersPerLine(int value)

Sets an integer value that specifies the maximum number of characters per one line. The default value is 0, that means no limit.

Parameters:

value - An integer value that specifies the maximum number of characters per one line.