com.groupdocs.parser.options

Class FormattedTextOptions

java.lang.Object

com.groupdocs.parser.options.FormattedTextOptions

public class FormattedTextOptions
extends Object

Provides the options which are used for formatted text extraction.

An instance of FormattedTextOptions class is used as parameter in Parser.getFormattedText(FormattedTextOptions) and Parser.getFormattedText(int, FormattedTextOptions) methods. See the usage examples there.

Learn more:

• Extract formatted text from document
• Extract a document text as HTML
• Extract a document text as Markdown
• Extract a document text as Plain text

Constructor Summary

Constructors

Constructor and Description
FormattedTextOptions() Initializes a new instance of the FormattedTextOptions class with no mode set.
FormattedTextOptions(FormattedTextMode mode) Initializes a new instance of the FormattedTextOptions class.

Method Summary

Modifier and Type	Method and Description
FormattedTextMode	getMode() Gets the formatted text extraction mode.
void	setMode(FormattedTextMode mode) Sets the formatted text extraction mode.

Methods inherited from class java.lang.Object

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

Constructor Detail

FormattedTextOptions

public FormattedTextOptions()

Initializes a new instance of the FormattedTextOptions class with no mode set.

FormattedTextOptions

public FormattedTextOptions(FormattedTextMode mode)

Initializes a new instance of the FormattedTextOptions class.

Parameters:

mode - The mode of formatted text extraction.

Method Detail

getMode

public FormattedTextMode getMode()

Gets the formatted text extraction mode.

Returns:

FormattedTextMode enumeration that contains a formatted text extraction mode.

setMode

public void setMode(FormattedTextMode mode)

Sets the formatted text extraction mode.

Parameters:

mode - FormattedTextMode enumeration that contains a formatted text extraction mode.