com.aspose.words

Class TxtLoadOptions

java.lang.Object

com.aspose.words.LoadOptions

com.aspose.words.TxtLoadOptions

public class TxtLoadOptions
extends LoadOptions

Allows to specify additional options when loading LoadFormat.TEXT document into a Document object.

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

Constructor Summary

Constructors

Constructor and Description
TxtLoadOptions() Initializes a new instance of this class with default values.

Method Summary

Modifier and Type	Method and Description
boolean	getAutoNumberingDetection() Gets a boolean value indicating either automatic numbering detection will be performed while loading a document.
boolean	getDetectNumberingWithWhitespaces() Allows to specify how numbered list items are recognized when document is imported from plain text format.
int	getDocumentDirection() Gets a document direction.
int	getLeadingSpacesOptions() Gets preferred option of a leading space handling.
int	getTrailingSpacesOptions() Gets preferred option of a trailing space handling.
void	setAutoNumberingDetection(boolean value) Sets a boolean value indicating either automatic numbering detection will be performed while loading a document.
void	setDetectNumberingWithWhitespaces(boolean value) Allows to specify how numbered list items are recognized when document is imported from plain text format.
void	setDocumentDirection(int value) Sets a document direction.
void	setLeadingSpacesOptions(int value) Sets preferred option of a leading space handling.
void	setTrailingSpacesOptions(int value) Sets preferred option of a trailing space handling.

Methods inherited from class com.aspose.words.LoadOptions

getBaseUri, getConvertMetafilesToPng, getConvertShapeToOfficeMath, getEncoding, getFontSettings, getLanguagePreferences, getLoadFormat, getMswVersion, getPassword, getPreserveIncludePictureField, getProgressCallback, getResourceLoadingCallback, getTempFolder, getUpdateDirtyFields, getWarningCallback, setBaseUri, setConvertMetafilesToPng, setConvertShapeToOfficeMath, setEncoding, setFontSettings, setLoadFormat, setMswVersion, setPassword, setPreserveIncludePictureField, setProgressCallback, setResourceLoadingCallback, setTempFolder, setUpdateDirtyFields, setWarningCallback

Methods inherited from class java.lang.Object

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

Constructor Detail

TxtLoadOptions

public TxtLoadOptions()

Initializes a new instance of this class with default values.

Method Detail

getAutoNumberingDetection

public boolean getAutoNumberingDetection()

Gets a boolean value indicating either automatic numbering detection will be performed while loading a document. The default value is true.

Returns:

A boolean value indicating either automatic numbering detection will be performed while loading a document.

setAutoNumberingDetection

public void setAutoNumberingDetection(boolean value)

Sets a boolean value indicating either automatic numbering detection will be performed while loading a document. The default value is true.

Parameters:

value - A boolean value indicating either automatic numbering detection will be performed while loading a document.

getDetectNumberingWithWhitespaces

public boolean getDetectNumberingWithWhitespaces()

Allows to specify how numbered list items are recognized when document is imported from plain text format. The default value is true.

If this option is set to false, lists recognition algorithm detects list paragraphs, when list numbers ends with either dot, right bracket or bullet symbols (such as "•", "*", "-" or "o").

If this option is set to true, whitespaces are also used as list number delimiters: list recognition algorithm for Arabic style numbering (1., 1.1.2.) uses both whitespaces and dot (".") symbols.

Returns:

The corresponding boolean value.

setDetectNumberingWithWhitespaces

public void setDetectNumberingWithWhitespaces(boolean value)

Allows to specify how numbered list items are recognized when document is imported from plain text format. The default value is true.

If this option is set to false, lists recognition algorithm detects list paragraphs, when list numbers ends with either dot, right bracket or bullet symbols (such as "•", "*", "-" or "o").

If this option is set to true, whitespaces are also used as list number delimiters: list recognition algorithm for Arabic style numbering (1., 1.1.2.) uses both whitespaces and dot (".") symbols.

Parameters:

value - The corresponding boolean value.

getTrailingSpacesOptions

public int getTrailingSpacesOptions()

Gets preferred option of a trailing space handling. Default value is TxtTrailingSpacesOptions.TRIM.

Returns:

Preferred option of a trailing space handling. The returned value is one of TxtTrailingSpacesOptions constants.

setTrailingSpacesOptions

public void setTrailingSpacesOptions(int value)

Sets preferred option of a trailing space handling. Default value is TxtTrailingSpacesOptions.TRIM.

Parameters:

value - Preferred option of a trailing space handling. The value must be one of TxtTrailingSpacesOptions constants.

getLeadingSpacesOptions

public int getLeadingSpacesOptions()

Gets preferred option of a leading space handling. Default value is TxtLeadingSpacesOptions.CONVERT_TO_INDENT.

Returns:

Preferred option of a leading space handling. The returned value is one of TxtLeadingSpacesOptions constants.

setLeadingSpacesOptions

public void setLeadingSpacesOptions(int value)

Sets preferred option of a leading space handling. Default value is TxtLeadingSpacesOptions.CONVERT_TO_INDENT.

Parameters:

value - Preferred option of a leading space handling. The value must be one of TxtLeadingSpacesOptions constants.

getDocumentDirection

public int getDocumentDirection()

Gets a document direction. The default value is DocumentDirection.LEFT_TO_RIGHT.

Returns:

A document direction. The returned value is one of DocumentDirection constants.

setDocumentDirection

public void setDocumentDirection(int value)

Sets a document direction. The default value is DocumentDirection.LEFT_TO_RIGHT.

Parameters:

value - A document direction. The value must be one of DocumentDirection constants.