Foxit PDF SDK
foxit.addon.layoutrecognition.LRContext Class Reference
Inheritance diagram for foxit.addon.layoutrecognition.LRContext:
foxit.common.Base

Public Member Functions

 LRContext (PDFPage page)
 Constructor, from a PDF Page object. More...
 
 LRContext (LRContext other)
 Constructor, with another context object. More...
 
LRStructureElement GetRootElement ()
 Get the root element of structure tree. More...
 
bool IsEmpty ()
 Check whether current object is empty or not. More...
 
Progressive StartParse (PauseCallback pause)
 Start to parse layout recognition for related PDF page. More...
 

Detailed Description

This class can be used to parse layout recognition to get the root element.

Constructor & Destructor Documentation

◆ LRContext() [1/2]

foxit.addon.layoutrecognition.LRContext.LRContext ( PDFPage  page)
inline

Constructor, from a PDF Page object.

Parameters
[in]pageA valid PDF page object.
Note
If module "LayoutRecognition" is not defined in the license information which is used in function common.Library.Initialize , that means user has no right in using layoutrecognition related functions and this constructor will throw exception foxit.common.ErrorCode.e_ErrNoLayoutRecognitionModuleRight .

◆ LRContext() [2/2]

foxit.addon.layoutrecognition.LRContext.LRContext ( LRContext  other)
inline

Constructor, with another context object.

Parameters
[in]otherAnother context object.

Member Function Documentation

◆ GetRootElement()

LRStructureElement foxit.addon.layoutrecognition.LRContext.GetRootElement ( )
inline

Get the root element of structure tree.

Please ensure current context object has been parsed successfully before calling this function; otherwise, no valid root structure element can be retrieved.

Returns
Root element.

◆ IsEmpty()

bool foxit.addon.layoutrecognition.LRContext.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.

◆ StartParse()

Progressive foxit.addon.layoutrecognition.LRContext.StartParse ( PauseCallback  pause)
inline

Start to parse layout recognition for related PDF page.

It may take a long time to do parsing, so Foxit PDF SDK uses a progressive process to do this. If there is any error occurs in parsing progress, this function will throw exception. Please refer to class foxit.PDFException and values starting from foxit.common.ErrorCode.e_ErrFile .

Parameters
[in]pausePause callback object which decides if the parsing process needs to be paused. This can be null which means not to pause during the parsing process. If this is not null, it should be a valid pause object implemented by user.
Returns
A progressive object. Please check the rate of current progress by function common.Progressive.GetRateOfProgress . If the rate is not 100 yet, call function common.Progressive.Continue to continue the progress until the progress is finished.