com.aspose.words

Class TxtSaveOptionsBase

java.lang.Object

com.aspose.words.SaveOptions

com.aspose.words.TxtSaveOptionsBase

Direct Known Subclasses:

MarkdownSaveOptions, TxtSaveOptions

public abstract class TxtSaveOptionsBase
extends SaveOptions

The base class for specifying additional options when saving a document into a text based formats.

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

Constructor Summary

Constructors

Constructor and Description
TxtSaveOptionsBase()

Method Summary

Modifier and Type	Method and Description
java.nio.charset.Charset	getEncoding()
int	getExportHeadersFootersMode() Specifies the way headers and footers are exported to the text formats.
boolean	getForcePageBreaks() Allows to specify whether the page breaks should be preserved during export.
java.lang.String	getParagraphBreak() Specifies the string to use as a paragraph break when exporting in text formats.
void	setEncoding(java.nio.charset.Charset value)
void	setExportHeadersFootersMode(int value) Specifies the way headers and footers are exported to the text formats.
void	setForcePageBreaks(boolean value) Allows to specify whether the page breaks should be preserved during export.
void	setParagraphBreak(java.lang.String value) Specifies the string to use as a paragraph break when exporting in text formats.

Methods inherited from class com.aspose.words.SaveOptions

createSaveOptions, createSaveOptions, getAllowEmbeddingPostScriptFonts, getDefaultTemplate, getDml3DEffectsRenderingMode, getDmlEffectsRenderingMode, getDmlRenderingMode, getExportGeneratorName, getImlRenderingMode, getMemoryOptimization, getPrettyFormat, getProgressCallback, getSaveFormat, getTempFolder, getUpdateCreatedTimeProperty, getUpdateFields, getUpdateLastPrintedProperty, getUpdateLastSavedTimeProperty, getUpdateSdtContent, getUseAntiAliasing, getUseHighQualityRendering, setAllowEmbeddingPostScriptFonts, setDefaultTemplate, setDml3DEffectsRenderingMode, setDmlEffectsRenderingMode, setDmlRenderingMode, setExportGeneratorName, setImlRenderingMode, setMemoryOptimization, setPrettyFormat, setProgressCallback, setSaveFormat, 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

Constructor Detail

TxtSaveOptionsBase

public TxtSaveOptionsBase()

Method Detail

getEncoding

public java.nio.charset.Charset getEncoding()

setEncoding

public void setEncoding(java.nio.charset.Charset value)

getParagraphBreak

public java.lang.String getParagraphBreak()

Specifies the string to use as a paragraph break when exporting in text formats.

The default value is ControlChar.CR_LF.

Returns:

The corresponding String value.

setParagraphBreak

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.

Parameters:

value - The corresponding String value.

getForcePageBreaks

public boolean getForcePageBreaks()

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.

Returns:

The corresponding boolean value.

setForcePageBreaks

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.

Parameters:

value - The corresponding boolean value.

getExportHeadersFootersMode

public int getExportHeadersFootersMode()

Specifies the way headers and footers are exported to the text formats. Default value is TxtExportHeadersFootersMode.PRIMARY_ONLY.

Returns:

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

setExportHeadersFootersMode

public void setExportHeadersFootersMode(int value)

Specifies the way headers and footers are exported to the text formats. Default value is TxtExportHeadersFootersMode.PRIMARY_ONLY.

Parameters:

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