TxtLoadOptions

Inheritance: java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions

All Implemented Interfaces: java.io.Serializable

public final class TxtLoadOptions extends LoadOptions implements Serializable

Options for loading Txt documents.

Constructors

Constructor Description
TxtLoadOptions() Initializes new instance of TxtLoadOptions class.

Methods

Method Description
getFormat()
getDetectNumberingWithWhitespaces() Allows to specify how numbered list items are recognized when plain text document is converted.
setDetectNumberingWithWhitespaces(boolean value) Allows to specify how numbered list items are recognized when plain text document is converted.
getTrailingSpacesOptions() Gets or sets preferred option of a trailing space handling.
setTrailingSpacesOptions(TxtTrailingSpacesOptions value) Gets or sets preferred option of a trailing space handling.
getLeadingSpacesOptions() Gets or sets preferred option of a leading space handling.
setLeadingSpacesOptions(TxtLeadingSpacesOptions value) Gets or sets preferred option of a leading space handling.
getEncoding() Gets or sets the encoding that will be used when loading Txt document.
getEncodingInternal()
setEncoding(Charset value) Gets or sets the encoding that will be used when loading Txt document.
setEncoding(String charsetName) Gets or sets the encoding that will be used when loading Txt document.

TxtLoadOptions()

public TxtLoadOptions()

Initializes new instance of TxtLoadOptions class.

getFormat()

public WordProcessingFileType getFormat()

Input document file type

Returns: WordProcessingFileType

getDetectNumberingWithWhitespaces()

public final boolean getDetectNumberingWithWhitespaces()

Allows to specify how numbered list items are recognized when plain text document is converted. 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 “\u2022”, “*”, “-” 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: boolean

setDetectNumberingWithWhitespaces(boolean value)

public final void setDetectNumberingWithWhitespaces(boolean value)

Allows to specify how numbered list items are recognized when plain text document is converted. 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 “\u2022”, “*”, “-” 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:

Parameter Type Description
value boolean

getTrailingSpacesOptions()

public final TxtTrailingSpacesOptions getTrailingSpacesOptions()

Gets or sets preferred option of a trailing space handling. Default value is TxtTrailingSpacesOptions.Trim.

Returns: TxtTrailingSpacesOptions

setTrailingSpacesOptions(TxtTrailingSpacesOptions value)

public final void setTrailingSpacesOptions(TxtTrailingSpacesOptions value)

Gets or sets preferred option of a trailing space handling. Default value is TxtTrailingSpacesOptions.Trim.

Parameters:

Parameter Type Description
value TxtTrailingSpacesOptions

getLeadingSpacesOptions()

public final TxtLeadingSpacesOptions getLeadingSpacesOptions()

Gets or sets preferred option of a leading space handling. Default value is TxtLeadingSpacesOptions.ConvertToIndent.

Returns: TxtLeadingSpacesOptions

setLeadingSpacesOptions(TxtLeadingSpacesOptions value)

public final void setLeadingSpacesOptions(TxtLeadingSpacesOptions value)

Gets or sets preferred option of a leading space handling. Default value is TxtLeadingSpacesOptions.ConvertToIndent.

Parameters:

Parameter Type Description
value TxtLeadingSpacesOptions

getEncoding()

public final Charset getEncoding()

Gets or sets the encoding that will be used when loading Txt document. Can be null. Default is null.

Returns: java.nio.charset.Charset

getEncodingInternal()

public System.Text.Encoding getEncodingInternal()

Returns: com.aspose.ms.System.Text.Encoding

setEncoding(Charset value)

public final void setEncoding(Charset value)

Gets or sets the encoding that will be used when loading Txt document. Can be null. Default is null.

Parameters:

Parameter Type Description
value java.nio.charset.Charset

setEncoding(String charsetName)

public final void setEncoding(String charsetName)

Gets or sets the encoding that will be used when loading Txt document. Can be null. Default is null.

Parameters:

Parameter Type Description
charsetName java.lang.String