Foxit PDF SDK
foxit.addon.ocr.OCR Class Reference
Inheritance diagram for foxit.addon.ocr.OCR:
foxit.common.Base

Public Types

enum  OCRConvertFormat {
  OCRConvertFormat.e_OCRConvertFormatDOCX = 0, OCRConvertFormat.e_OCRConvertFormatDOC = 1, OCRConvertFormat.e_OCRConvertFormatRTF = 2, OCRConvertFormat.e_OCRConvertFormatXLSX = 3,
  OCRConvertFormat.e_OCRConvertFormatXLS = 4, OCRConvertFormat.e_OCRConvertFormatPPTX = 5, OCRConvertFormat.e_OCRConvertFormatHTML = 6
}
 Enumeration for format used for OCR converting. More...
 

Public Member Functions

 OCR ()
 Constructor.
 
 OCR (OCR other)
 Constructor, with another ocr object. More...
 
OCRSuspectInfoArray GetOCRSuspectsInfo (PDFDoc ocred_pdf_doc)
 Get OCR suspicious information. More...
 
bool IsEmpty ()
 Check whether current object is empty or not. More...
 
void OCRConvertTo (OCR.OCRConvertFormat format, string src_pdf_path, string password, string saved_file_path, Range page_range, bool is_retain_flowing_text)
 OCR the PDF document and convert it to a specified format document. More...
 
void OCRConvertTo (OCR.OCRConvertFormat format, string src_pdf_path, string password, string saved_file_path, Range page_range, bool is_retain_flowing_text, OCRConfig config)
 OCR the PDF document and convert it to a specified format document. More...
 
void OCRPDFDocument (PDFDoc pdf_doc, bool is_editable)
 OCR each page of a PDF document. More...
 
void OCRPDFDocument (PDFDoc pdf_doc, bool is_editable, OCRConfig config)
 OCR each page of a PDF document. More...
 
void OCRPDFDocuments (OCRSettingDataArray settingdata_array)
 OCR multiple pages of multiple PDF documents. More...
 
void OCRPDFPage (PDFPage pdf_page, bool is_editable)
 OCR a PDF page. More...
 
void OCRPDFPage (PDFPage pdf_page, bool is_editable, OCRConfig config)
 OCR a PDF page. More...
 

Detailed Description

This class is used to do OCR for a PDF page or a PDF document. Please ensure OCR engine has been initialized before using this class.

See also
OCREngine

Member Enumeration Documentation

◆ OCRConvertFormat

Enumeration for format used for OCR converting.

Values of this enumeration should be used alone.

Enumerator
e_OCRConvertFormatDOCX 

OCR convert format: DOCX.

e_OCRConvertFormatDOC 

OCR convert format: DOC.

e_OCRConvertFormatRTF 

OCR convert format: RTF.

e_OCRConvertFormatXLSX 

OCR convert format: XLSX.

e_OCRConvertFormatXLS 

OCR convert format: XLS.

e_OCRConvertFormatPPTX 

OCR convert format: PPTX.

e_OCRConvertFormatHTML 

OCR convert format: HTML.

Constructor & Destructor Documentation

◆ OCR()

foxit.addon.ocr.OCR.OCR ( OCR  other)
inline

Constructor, with another ocr object.

Parameters
[in]otherAnother ocr object.

Member Function Documentation

◆ GetOCRSuspectsInfo()

OCRSuspectInfoArray foxit.addon.ocr.OCR.GetOCRSuspectsInfo ( PDFDoc  ocred_pdf_doc)
inline

Get OCR suspicious information.

The parameter ocred_pdf_doc is a valid PDF document that should have been ocred.

Parameters
[in]ocred_pdf_docA valid PDF document object.
Returns
An array of OCRSuspectInfo objects, If its value is empty, that means the document OCR has no suspicious information.

◆ IsEmpty()

bool foxit.addon.ocr.OCR.IsEmpty ( )
inline

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns
true means current object is empty, while false means not.

◆ OCRConvertTo() [1/2]

void foxit.addon.ocr.OCR.OCRConvertTo ( OCR.OCRConvertFormat  format,
string  src_pdf_path,
string  password,
string  saved_file_path,
Range  page_range,
bool  is_retain_flowing_text 
)
inline

OCR the PDF document and convert it to a specified format document.

Parameters
[in]formatThe format of the document to convert. Please refer to values starting from foxit.addon.ocr.OCR.OCRConvertFormat.e_OCRConvertFormatDOCX and this should be one of these values.
[in]src_pdf_pathThe source PDF file path.This should not be an empty string.
[in]passwordThe password of the source PDF file. If the PDF file is not encrypted, this should be an empty string.
[in]saved_file_pathThe path of the file to save. This should not be an empty string.
[in]page_rangeThe range of pages that need to be converted. If this is an empty range, that means to convert each page of the PDF document.
[in]is_retain_flowing_texttrue means the generated document will retain flowing text, the text may be reformatted and page breaks cannot be guaranteed to be retained. false means the generated document will retain original page layout.
This parameter is only useful for the following format types:
foxit.addon.ocr.OCR.OCRConvertFormat.e_OCRConvertFormatRTF , foxit.addon.ocr.OCR.OCRConvertFormat.e_OCRConvertFormatDOC , foxit.addon.ocr.OCR.OCRConvertFormat.e_OCRConvertFormatDOCX .
Default value: true.
Returns
None.

◆ OCRConvertTo() [2/2]

void foxit.addon.ocr.OCR.OCRConvertTo ( OCR.OCRConvertFormat  format,
string  src_pdf_path,
string  password,
string  saved_file_path,
Range  page_range,
bool  is_retain_flowing_text,
OCRConfig  config 
)
inline

OCR the PDF document and convert it to a specified format document.

Parameters
[in]formatThe format of the document to convert. Please refer to values starting from foxit.addon.ocr.OCR.OCRConvertFormat.e_OCRConvertFormatDOCX and this should be one of these values.
[in]src_pdf_pathThe source PDF file path.This should not be an empty string.
[in]passwordThe password of the source PDF file. If the PDF file is not encrypted, this should be an empty string.
[in]saved_file_pathThe path of the file to save. This should not be an empty string.
[in]page_rangeThe range of pages that need to be converted. If this is an empty range, that means to convert each page of the PDF document.
[in]is_retain_flowing_texttrue means the generated document will retain flowing text, the text may be reformatted and page breaks cannot be guaranteed to be retained. false means the generated document will retain original page layout.
This parameter is only useful for the following format types:
foxit.addon.ocr.OCR.OCRConvertFormat.e_OCRConvertFormatRTF , foxit.addon.ocr.OCR.OCRConvertFormat.e_OCRConvertFormatDOC , foxit.addon.ocr.OCR.OCRConvertFormat.e_OCRConvertFormatDOCX .
Default value: true.
[in]configThe OCRConfig object.
Returns
None.

◆ OCRPDFDocument() [1/2]

void foxit.addon.ocr.OCR.OCRPDFDocument ( PDFDoc  pdf_doc,
bool  is_editable 
)
inline

OCR each page of a PDF document.

After this function succeeds, the PDF page content may be changed. It is better to parse or re-parse PDF pages in the input PDF document before using these pages.

Parameters
[in]pdf_docA valid PDF document object.
[in]is_editabletrue means the OCR result is editable. false means the OCR result can only be searched but not be edited.
Returns
None.

◆ OCRPDFDocument() [2/2]

void foxit.addon.ocr.OCR.OCRPDFDocument ( PDFDoc  pdf_doc,
bool  is_editable,
OCRConfig  config 
)
inline

OCR each page of a PDF document.

After this function succeeds, the PDF page content may be changed. It is better to parse or re-parse PDF pages in the input PDF document before using these pages.

Parameters
[in]pdf_docA valid PDF document object.
[in]is_editabletrue means the OCR result is editable. false means the OCR result can only be searched but not be edited.
[in]configThe OCRConfig .
Returns
None.

◆ OCRPDFDocuments()

void foxit.addon.ocr.OCR.OCRPDFDocuments ( OCRSettingDataArray  settingdata_array)
inline

OCR multiple pages of multiple PDF documents.

This function can be used to batch process multiple documents or pages. Users can set documents and page ranges via OCRSettingDataArray . The time performance of this function will be better than calling OCR.OCRPDFDocument or OCR.OCRPDFPage multiple times when dealing with a large number of documents or pages. After successful execution, the page content may be changed, it is better to parse or re-parse the PDF pages before using these pages.

Parameters
[in]settingdata_arrayAn array of OCRSettingData objects, if the parameter page_range of OCRSettingData object is empty, that means OCR each page of the PDF document.
Returns
None.

◆ OCRPDFPage() [1/2]

void foxit.addon.ocr.OCR.OCRPDFPage ( PDFPage  pdf_page,
bool  is_editable 
)
inline

OCR a PDF page.

After this function succeeds, the PDF page content may be changed and the input PDF page is recommended to be re- parsed.

Parameters
[in]pdf_pageA valid PDF page object. This PDF page should have been parsed.
[in]is_editabletrue means the OCR result is editable. false means the OCR result can only be searched but not be edit.
Returns
None.

◆ OCRPDFPage() [2/2]

void foxit.addon.ocr.OCR.OCRPDFPage ( PDFPage  pdf_page,
bool  is_editable,
OCRConfig  config 
)
inline

OCR a PDF page.

After this function succeeds, the PDF page content may be changed and the input PDF page is recommended to be re- parsed.

Parameters
[in]pdf_pageA vaild PDF page object. This PDF page should have been parsed.
[in]is_editabletrue means the OCR result is editable. false means the OCR result can only be searched but not be edited.
[in]configThe OCRConfig .
Returns
None.