All Classes Namespaces Functions Enumerations Enumerator Pages
foxit.addon.xfa.XFAPage Class Reference
Inheritance diagram for foxit.addon.xfa.XFAPage:
foxit.common.Base

Public Member Functions

 XFAPage (XFAPage other)
 Constructor, with another XFA page object.
 
Matrix2D GetDisplayMatrix (int left, int top, int width, int height, Rotation rotate)
 Get the display matrix, from PDF coordinate system to targeted device coordinate system. More...
 
float GetHeight ()
 Get the height of the XFA page. More...
 
XFAWidget GetWidgetAtDevicePoint (Matrix2D matrix, PointF device_point, float tolerance)
 Get the XFA widget at a specified point, in device coordination system. More...
 
float GetWidth ()
 Get the width. More...
 
bool IsEmpty ()
 Check whether current object is empty or not. More...
 

Detailed Description

Class addon::xfa::XFAPage represents the XFA page which is retrieved from XFA document object. To render a XFA page, please use function common::Renderer::StartRenderXFAPage.

See Also
common::Renderer

Member Function Documentation

Matrix2D foxit.addon.xfa.XFAPage.GetDisplayMatrix ( int  left,
int  top,
int  width,
int  height,
Rotation  rotate 
)
inline

Get the display matrix, from PDF coordinate system to targeted device coordinate system.

Parameters
leftLeft position of the transformation area in device coordinate system, commonly in pixels.
topTop position of the transformation area in device coordinate system, commonly in pixels.
widthWidth of the transformation area in device coordinate system, commonly in pixels.
heightHeight of the transformation area in device coordinate system, commonly in pixels.
rotateRotation value. Please refer to e_RotationXXX values and this should be one of these values.
Returns
A Matrix object that receives the display matrix used for current XFA page. If there is any error, a Matrix with all value 0 will be returned.
float foxit.addon.xfa.XFAPage.GetHeight ( )
inline

Get the height of the XFA page.

Returns
A float value that receives the height of current XFA page.
XFAWidget foxit.addon.xfa.XFAPage.GetWidgetAtDevicePoint ( Matrix2D  matrix,
PointF  device_point,
float  tolerance 
)
inline

Get the XFA widget at a specified point, in device coordination system.

Parameters
matrixThe transformation matrix. Usually this is returned by function addon::xfa::XFAPage::GetDisplayMatrix.
device_pointA point in device coordination system.
toleranceTolerance value. Valid range: 0.0f to 30.0f.
Returns
An XFA Widget object.
float foxit.addon.xfa.XFAPage.GetWidth ( )
inline

Get the width.

Returns
A float value that receives the width of current XFA page.
bool foxit.addon.xfa.XFAPage.IsEmpty ( )
inline

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.

Foxit Software Corporation Logo
@2018 Foxit Software Incorporated. All rights reserved.