Foxit PDF SDK
FoxitPDFSDKPython3.LRContext Class Reference
Inheritance diagram for FoxitPDFSDKPython3.LRContext:
FoxitPDFSDKPython3.Base

Public Member Functions

def LRContext (page)
 Constructor, from a PDF Page object. More...
 
def GetRootElement ()
 Get the root element of structure tree. More...
 
def IsEmpty ()
 Check whether current object is empty or not. More...
 
def StartParse (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()

def FoxitPDFSDKPython3.LRContext.LRContext (   page)

Constructor, from a PDF Page object.

Constructor, with another context object.

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

Member Function Documentation

◆ GetRootElement()

def FoxitPDFSDKPython3.LRContext.GetRootElement ( )

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

def FoxitPDFSDKPython3.LRContext.IsEmpty ( )

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

def FoxitPDFSDKPython3.LRContext.StartParse (   pause)

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 FoxitPDFSDKPython3 and values starting from FoxitPDFSDKPython3.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 FoxitPDFSDKPython3.Progressive.GetRateOfProgress . If the rate is not 100 yet, call function FoxitPDFSDKPython3.Progressive.Continue to continue the progress until the progress is finished.