All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
pdftron::PDF::DataExtractionOptions Class Reference

#include <DataExtractionOptions.h>

+ Inheritance diagram for pdftron::PDF::DataExtractionOptions:

Public Member Functions

 DataExtractionOptions ()
 
 ~DataExtractionOptions ()
 
bool GetDeepLearningAssist ()
 
DataExtractionOptions & SetDeepLearningAssist (bool value)
 
UString GetFormExtractionEngine ()
 
DataExtractionOptions & SetFormExtractionEngine (const UString &value)
 
UString GetLanguage ()
 
DataExtractionOptions & SetLanguage (const UString &value)
 
UString GetOverlappingFormFieldBehavior ()
 
DataExtractionOptions & SetOverlappingFormFieldBehavior (const UString &value)
 
UString GetPDFPassword ()
 
DataExtractionOptions & SetPDFPassword (const UString &value)
 
UString GetPages ()
 
DataExtractionOptions & SetPages (const UString &value)
 
- Public Member Functions inherited from pdftron::PDF::OptionsBase
 OptionsBase ()
 

Additional Inherited Members

- Static Public Member Functions inherited from pdftron::PDF::OptionsBase
static SDF::Obj GetArray (SDF::Obj dict, const char *key)
 
static void PutNumber (SDF::Obj dict, const char *key, double num)
 
static void PutBool (SDF::Obj dict, const char *key, bool val)
 
static void PutText (SDF::Obj dict, const char *key, const UString &text)
 
static void PutRect (SDF::Obj dict, const char *key, const Rect &rect)
 
static void PushBackNumber (SDF::Obj dict, const char *key, double num)
 
static void PushBackBool (SDF::Obj dict, const char *key, bool val)
 
static void PushBackText (SDF::Obj dict, const char *key, const UString &text)
 
static void PushBackRect (SDF::Obj dict, const char *key, const Rect &rect)
 
static Rect RectFromArray (SDF::Obj nums)
 
static void InsertRectCollection (SDF::Obj dict, const char *key, const RectCollection &rects, int index)
 
static Rect RectFromArray (void *)
 
static double ColorPtToNumber (const ColorPt &cp)
 
static ColorPt ColorPtFromNumber (double dnum)
 

Detailed Description

Definition at line 9 of file DataExtractionOptions.h.

Constructor & Destructor Documentation

pdftron::PDF::DataExtractionOptions::DataExtractionOptions ( )
pdftron::PDF::DataExtractionOptions::~DataExtractionOptions ( )

Member Function Documentation

bool pdftron::PDF::DataExtractionOptions::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.

Returns
a bool, the current value for DeepLearningAssist.
UString pdftron::PDF::DataExtractionOptions::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.

Returns
a UString, the current value for FormExtractionEngine.
UString pdftron::PDF::DataExtractionOptions::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.

Returns
a UString, the current value for Language.
UString pdftron::PDF::DataExtractionOptions::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).

Returns
a UString, the current value for OverlappingFormFieldBehavior.
UString pdftron::PDF::DataExtractionOptions::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.

Returns
a UString, the current value for Pages.
UString pdftron::PDF::DataExtractionOptions::GetPDFPassword ( )

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

Returns
a UString, the current value for PDFPassword.
DataExtractionOptions& pdftron::PDF::DataExtractionOptions::SetDeepLearningAssist ( bool  value)

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.

Parameters
value,:the new value for DeepLearningAssist
Returns
this object, for call chaining
DataExtractionOptions& pdftron::PDF::DataExtractionOptions::SetFormExtractionEngine ( const UString &  value)

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.

Parameters
value,:the new value for FormExtractionEngine
Returns
this object, for call chaining
DataExtractionOptions& pdftron::PDF::DataExtractionOptions::SetLanguage ( const UString &  value)

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.

Parameters
value,:the new value for Language
Returns
this object, for call chaining
DataExtractionOptions& pdftron::PDF::DataExtractionOptions::SetOverlappingFormFieldBehavior ( const UString &  value)

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).

Parameters
value,:the new value for OverlappingFormFieldBehavior
Returns
this object, for call chaining
DataExtractionOptions& pdftron::PDF::DataExtractionOptions::SetPages ( const UString &  value)

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.

Parameters
value,:the new value for Pages
Returns
this object, for call chaining
DataExtractionOptions& pdftron::PDF::DataExtractionOptions::SetPDFPassword ( const UString &  value)

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

Parameters
value,:the new value for PDFPassword
Returns
this object, for call chaining
The documentation for this class was generated from the following file: