com.groupdocs.parser.options

Class TextOptions

java.lang.Object

com.groupdocs.parser.options.TextOptions

public class TextOptions
extends Object

Provides the options which are used for text extraction.

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

It's used to specify the raw mode of text extraction. A text in this mode is extracted in a non-accurate way but faster than in the standard mode. If the raw mode doesn't support the document format, then this parameter is ignored and the standard mode is used.

Learn more:

• Extract text in Raw Mode
• Extract text in Accurate Mode

Constructor Summary

Constructors

Constructor and Description
TextOptions(boolean useRawModeIfPossible) Initializes a new instance of the TextOptions class.
TextOptions(boolean useRawModeIfPossible, boolean useOcr) Initializes a new instance of the TextOptions class with the OCR usage option.
TextOptions(boolean useRawModeIfPossible, boolean useOcr, OcrOptions ocrOptions) Initializes a new instance of the TextOptions class with the ability to set OCR options.

Method Summary

Modifier and Type	Method and Description
OcrOptions	getOcrOptions() Gets the additional options for OCR functionality.
boolean	isUseOcr() Gets the value that indicates whether the OCR Connector is used to extract a text.
boolean	isUseRawModeIfPossible() Gets the value that indicates whether the raw mode is used.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextOptions

public TextOptions(boolean useRawModeIfPossible)

Initializes a new instance of the TextOptions class.

Parameters:

useRawModeIfPossible - The value that indicates whether the raw mode is used.

TextOptions

public TextOptions(boolean useRawModeIfPossible,
                   boolean useOcr)

Initializes a new instance of the TextOptions class with the OCR usage option.

Parameters:

useRawModeIfPossible - The value that indicates whether the raw mode is used.

useOcr - The value that indicates whether the OCR functionality is used to extract a text.

TextOptions

public TextOptions(boolean useRawModeIfPossible,
                   boolean useOcr,
                   OcrOptions ocrOptions)

Initializes a new instance of the TextOptions class with the ability to set OCR options.

Parameters:

useRawModeIfPossible - The value that indicates whether the raw mode is used.

useOcr - The value that indicates whether the OCR functionality is used to extract a text.

ocrOptions - The additional options for OCR functionality.

Method Detail

isUseRawModeIfPossible

public boolean isUseRawModeIfPossible()

Gets the value that indicates whether the raw mode is used.

Returns:

true if the raw mode is used; otherwise, false.

isUseOcr

public boolean isUseOcr()

Gets the value that indicates whether the OCR Connector is used to extract a text.

Returns:

true if the OCR functionality is used; otherwise, false.

getOcrOptions

public OcrOptions getOcrOptions()

Gets the additional options for OCR functionality.

Returns:

An instance of OcrOptions class with the additional OCR options.