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

Public Member Functions

def OFDPage ()
 Constructor. More...
 
def GetDisplayMatrix (left, top, width, height, rotate)
 Get display matrix. More...
 
def GetHeight ()
 Get page height (unit is 1/72 inch). More...
 
def GetWidth ()
 Get page width (unit is 1/72 inch). More...
 
def IsEmpty ()
 Check whether current object is empty or not. More...
 
def Release ()
 Release current OFD page object. More...
 

Detailed Description

This class is used to get information of an OFD page. Please ensure FoxitPDFSDKPython3.Library.InitializeOFDEngine has been called successfully before using this class.

See also
FoxitPDFSDKPython3.Library

Constructor & Destructor Documentation

◆ OFDPage()

def FoxitPDFSDKPython3.OFDPage.OFDPage ( )

Constructor.

Constructor, with another OFD page object.

Member Function Documentation

◆ GetDisplayMatrix()

def FoxitPDFSDKPython3.OFDPage.GetDisplayMatrix (   left,
  top,
  width,
  height,
  rotate 
)

Get display matrix.

This function is used to get a matrix for displaying the page.

Parameters
[in]leftLeft position of the display area.
[in]topTop position of the display area.
[in]widthWidth of the display area.
[in]heightHeight of the display area.
[in]rotateRotation of the display area. Please refer to values starting from FoxitPDFSDKPython3.e_Rotation0 and this should be one of these values.
Returns
A matrix for displaying the page.

◆ GetHeight()

def FoxitPDFSDKPython3.OFDPage.GetHeight ( )

Get page height (unit is 1/72 inch).

Returns
Page height.

◆ GetWidth()

def FoxitPDFSDKPython3.OFDPage.GetWidth ( )

Get page width (unit is 1/72 inch).

Returns
Page width.

◆ IsEmpty()

def FoxitPDFSDKPython3.OFDPage.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.

◆ Release()

def FoxitPDFSDKPython3.OFDPage.Release ( )

Release current OFD page object.

Please call this function before FoxitPDFSDKPython3.Library.ReleaseOFDEngine to release current OFD page object.

Returns
None.