Foxit PDF SDK
FSDK.OFDDoc Class Reference

Public Member Functions

 constructor ()
 Constructor.
 
 constructor (path, password)
 Constructor, from an existing OFD file path. More...
 
 GetPage (index)
 Get OFD page object by index. More...
 
 GetPageCount ()
 Get page count of current OFD document. More...
 
 IsEmpty ()
 Check whether current object is empty or not. More...
 
 Release ()
 Release current OFD document object. More...
 

Detailed Description

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

See also
FSDK.Library

Member Function Documentation

◆ constructor()

FSDK.OFDDoc.constructor ( path  ,
password   
)

Constructor, from an existing OFD file path.

Parameters
[in]pathA full path of an existing PDF file. It should not be an empty string.
[in]passwordPassword for the OFD file. It should be an empty string if the OFD file is not encrypted.

◆ GetPage()

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

FSDK.OFDDoc.GetPageCount ( )

Get page count of current OFD document.

Returns
Page count of current OFD document.

◆ IsEmpty()

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

FSDK.OFDDoc.Release ( )

Release current OFD document object.

Please call this function before FSDK.Library.ReleaseOFDEngine to release current OFD document object.

Returns
None.