Class DataExtractionOptions

Inheritance

object

OptionsBase

DataExtractionOptions

Inherited Members

OptionsBase.mObjSet

OptionsBase.ColorPtToNumber(ColorPt)

OptionsBase.ColorPtFromNumber(double)

OptionsBase.GetArray(string)

OptionsBase.PutNumber(string, double)

OptionsBase.PutBool(string, bool)

OptionsBase.PutText(string, string)

OptionsBase.PutRect(string, Rect)

OptionsBase.PushBackNumber(string, double)

OptionsBase.PushBackBool(string, bool)

OptionsBase.PushBackText(string, string)

OptionsBase.PushBackRect(string, Rect)

OptionsBase.RectFromArray(Obj)

OptionsBase.insertRectCollection(string, RectCollection, int)

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: pdftron.PDF

Assembly: PDFNet.dll

Syntax

public class DataExtractionOptions : OptionsBase

Constructors

DataExtractionOptions()

Constructor.

Declaration

public DataExtractionOptions()

Methods

GetDeepLearningAssist()

Gets the value DeepLearningAssist from the options object Specifies if Deep Learning is used with table recognition in the DocStructure engine. The default is false. When true, table recognition accuracy improves at the cost of increased processing time. This only affects the DocStructure engine.

Declaration

public bool GetDeepLearningAssist()

Returns

Type	Description
bool	a bool, Specifies if Deep Learning is used with table recognition in the DocStructure engine. The default is false. When true, table recognition accuracy improves at the cost of increased processing time. This only affects the DocStructure engine.

GetFormExtractionEngine()

Gets the value FormExtractionEngine from the options object Specifies the form extraction engine used in DetectAndAddFormFieldsToPDF, either 'Form' or 'FormKeyValue'. The default is 'Form'. Note: The 'FormKeyValue' engine is experimental and subject to change.

Declaration

public string GetFormExtractionEngine()

Returns

Type	Description
string	a String^, Specifies the form extraction engine used in DetectAndAddFormFieldsToPDF, either 'Form' or 'FormKeyValue'. The default is 'Form'. Note: The 'FormKeyValue' engine is experimental and subject to change.

GetLanguage()

Gets the value Language from the options object Specifies the OCR language(s). Use 3-letter ISO 639-2 language codes, separated by spaces. Example: "eng deu spa fra". The default is English.

Declaration

public string GetLanguage()

Returns

Type	Description
string	a String, Specifies the OCR language(s). Use 3-letter ISO 639-2 language codes, separated by spaces. Example: "eng deu spa fra". The default is English..

GetOverlappingFormFieldBehavior()

Gets the value OverlappingFormFieldBehavior from the options object When a detected form field overlaps with an existing one, keep either the old field (value 'KeepOld'), or the new one (value 'KeepNew', default).

Declaration

public string GetOverlappingFormFieldBehavior()

Returns

Type	Description
string	a String^, When a detected form field overlaps with an existing one, keep either the old field (value 'KeepOld'), or the new one (value 'KeepNew', default)..

GetPDFPassword()

Gets the value PDFPassword from the options object Specifies the password if the PDF requires one. The default is no password.

Declaration

public string GetPDFPassword()

Returns

Type	Description
string	a String, Specifies the password if the PDF requires one. The default is no password..

GetPages()

Gets the value Pages from the options object Specifies a range of pages to be converted, such as "1-5". By default all pages are converted. The first page has the page number of 1.

Declaration

public string GetPages()

Returns

Type	Description
string	a String, Specifies a range of pages to be converted, such as "1-5". By default all pages are converted. The first page has the page number of 1..

SetDeepLearningAssist(bool)

Sets the value for DeepLearningAssist in the options object Specifies if Deep Learning is used with table recognition in the DocStructure engine. The default is false. When true, table recognition accuracy improves at the cost of increased processing time. This only affects the DocStructure engine.

Declaration

public DataExtractionOptions SetDeepLearningAssist(bool value)

Parameters

Type	Name	Description
bool	value	Specifies if Deep Learning is used with table recognition in the DocStructure engine. The default is false. When true, table recognition accuracy improves at the cost of increased processing time. This only affects the DocStructure engine.

Returns

Type	Description
DataExtractionOptions	this object, for call chaining

SetFormExtractionEngine(string)

Sets the value for FormExtractionEngine in the options object Specifies the form extraction engine used in DetectAndAddFormFieldsToPDF, either 'Form' or 'FormKeyValue'. The default is 'Form'. Note: The 'FormKeyValue' engine is experimental and subject to change.

Declaration

public DataExtractionOptions SetFormExtractionEngine(string value)

Parameters

Type	Name	Description
string	value	Specifies the form extraction engine used in DetectAndAddFormFieldsToPDF, either 'Form' or 'FormKeyValue'. The default is 'Form'. Note: The 'FormKeyValue' engine is experimental and subject to change.

Returns

Type	Description
DataExtractionOptions	this object, for call chaining

SetLanguage(string)

Sets the value for Language in the options object Specifies the OCR language(s). Use 3-letter ISO 639-2 language codes, separated by spaces. Example: "eng deu spa fra". The default is English.

Declaration

public DataExtractionOptions SetLanguage(string value)

Parameters

Type	Name	Description
string	value	Specifies the OCR language(s). Use 3-letter ISO 639-2 language codes, separated by spaces. Example: "eng deu spa fra". The default is English.

Returns

Type	Description
DataExtractionOptions	this object, for call chaining

SetOverlappingFormFieldBehavior(string)

Sets the value for OverlappingFormFieldBehavior in the options object When a detected form field overlaps with an existing one, keep either the old field (value 'KeepOld'), or the new one (value 'KeepNew', default).

Declaration

public DataExtractionOptions SetOverlappingFormFieldBehavior(string value)

Parameters

Type	Name	Description
string	value	When a detected form field overlaps with an existing one, keep either the old field (value 'KeepOld'), or the new one (value 'KeepNew', default).

Returns

Type	Description
DataExtractionOptions	this object, for call chaining

SetPDFPassword(string)

Sets the value for PDFPassword in the options object Specifies the password if the PDF requires one. The default is no password.

Declaration

public DataExtractionOptions SetPDFPassword(string value)

Parameters

Type	Name	Description
string	value	Specifies the password if the PDF requires one. The default is no password.

Returns

Type	Description
DataExtractionOptions	this object, for call chaining

SetPages(string)

Sets the value for Pages in the options object Specifies a range of pages to be converted, such as "1-5". By default all pages are converted. The first page has the page number of 1.

Declaration

public DataExtractionOptions SetPages(string value)

Parameters

Type	Name	Description
string	value	Specifies a range of pages to be converted, such as "1-5". By default all pages are converted. The first page has the page number of 1.

Returns

Type	Description
DataExtractionOptions	this object, for call chaining