Foxit PDF SDK
fsdk.LRElement Class Reference

Public Member Functions

def GetElementType ()
 Get element type. More...
 
def IsContentElement ()
 Check whether current object is content element or not. More...
 
def IsEmpty ()
 Check whether current object is empty or not. More...
 
def IsGraphicsObjectElement ()
 Check whether current object is graphics object element or not. More...
 
def IsStructureElement ()
 Check whether current object is structure element or not. More...
 
def StringifyType ()
 Convert type (enum value) of current element to a short and memorable string (text) representation. More...
 

Detailed Description

This class represents base layout recognition element.

Member Function Documentation

◆ GetElementType()

def fsdk.LRElement.GetElementType ( )

Get element type.

Returns
Element type. Please refer to values starting from fsdk.LRElementE_ElementTypeDocument and this would be one of these values.

◆ IsContentElement()

def fsdk.LRElement.IsContentElement ( )

Check whether current object is content element or not.

Returns
true means current object is content element, while false means current object is not content element.

◆ IsEmpty()

def fsdk.LRElement.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.

◆ IsGraphicsObjectElement()

def fsdk.LRElement.IsGraphicsObjectElement ( )

Check whether current object is graphics object element or not.

Returns
true means current object is graphics object element, while false means current object is not graphics object element.

◆ IsStructureElement()

def fsdk.LRElement.IsStructureElement ( )

Check whether current object is structure element or not.

Returns
true means current object is structure element, while false means current object is not structure element,

◆ StringifyType()

def fsdk.LRElement.StringifyType ( )

Convert type (enum value) of current element to a short and memorable string (text) representation.

Returns
A short and memorable string that represents type of current element. If there is no short and memorable string, this function would return an empty string.