Foxit PDF SDK

Public Member Functions | List of all members
FSDK.OFDPage Class Reference

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

## Detailed Description

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

See also
  FSDK.Library

## Member Function Documentation

## ◆ GetDisplayMatrix()

FSDK.OFDPage.GetDisplayMatrix | ( | left | ,
|  | top | ,
|  | width | ,
|  | height | ,
|  | rotate |
| ) |  |

Get display matrix.

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

Parameters

  [in] | left | Left position of the display area.
  [in] | top | Top position of the display area.
  [in] | width | Width of the display area.
  [in] | height | Height of the display area.
  [in] | rotate | Rotation of the display area. Please refer to values starting from FSDK.e_Rotation0 and this should be one of these values.

Returns
  A matrix for displaying the page.

## ◆ GetHeight()

FSDK.OFDPage.GetHeight | ( |  | ) |

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

Returns
  Page height.

## ◆ GetWidth()

FSDK.OFDPage.GetWidth | ( |  | ) |

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

Returns
  Page width.

## ◆ IsEmpty()

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

FSDK.OFDPage.Release | ( |  | ) |

Release current OFD page object.

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

Returns
  None.