Foxit PDF SDK
foxit.addon.ocr.OCRSettingData Class Reference

Inherits SystemIDisposable.

Public Member Functions

 OCRSettingData ()
 Constructor.
 
 OCRSettingData (PDFDoc pdf_doc, Range page_range, bool is_editable)
 Constructor, with parameters. More...
 
void Set (PDFDoc pdf_doc, Range page_range, bool is_editable)
 Set value. More...
 

Properties

bool is_editable [get, set]
 Decide whether the OCR result is editable. true means the OCR result is editable. false means the OCR result can only be searched but not be edited.
 
Rangepage_range [get, set]
 The range of pages that need to be OCR.
 
PDFDocpdf_doc [get, set]
 A valid PDF document that need to be OCR.
 

Detailed Description

This class represents setting data used for OCR.

Constructor & Destructor Documentation

◆ OCRSettingData()

foxit.addon.ocr.OCRSettingData.OCRSettingData ( PDFDoc  pdf_doc,
Range  page_range,
bool  is_editable 
)
inline

Constructor, with parameters.

Parameters
[in]pdf_docA valid PDF document.
[in]page_rangeThe range of pages that need to be OCR.
[in]is_editabletrue means the OCR result is editable. false means the OCR result can only be searched but not be edited.

Member Function Documentation

◆ Set()

void foxit.addon.ocr.OCRSettingData.Set ( PDFDoc  pdf_doc,
Range  page_range,
bool  is_editable 
)
inline

Set value.

Parameters
[in]pdf_docA valid PDF document.
[in]page_rangeThe range of pages that need to be OCR.
[in]is_editabletrue means the OCR result is editable. false means the OCR result can only be searched but not be edited.
Returns
None.