Foxit PDF SDK
fsdk.OFDDoc Class Reference

Public Member Functions

def GetPage (index)
 Get OFD page object by index. More...
 
def GetPageCount ()
 Get page count of current OFD document. More...
 
def IsEmpty ()
 Check whether current object is empty or not. More...
 
def Release ()
 Release current OFD document object. More...
 

Detailed Description

This class is used to get information of an OFD document. Please ensure fsdk.LibraryInitializeOFDEngine has been called successfully before using this class.

See also
fsdk.Library

Member Function Documentation

◆ GetPage()

def fsdk.OFDDoc.GetPage (   index)

Get OFD page object by index.

Parameters
[in]indexIndex of the page. Valid range: from 0 to (page_count-1). page_count returned by function fsdk.OFDDoc.GetPageCount .
Returns
OFD page object.

◆ GetPageCount()

def fsdk.OFDDoc.GetPageCount ( )

Get page count of current OFD document.

Returns
Page count of current OFD document.

◆ IsEmpty()

def fsdk.OFDDoc.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 fsdk.OFDDoc.Release ( )

Release current OFD document object.

Please call this function before fsdk.LibraryReleaseOFDEngine to release current OFD document object.

Returns
None.