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
◆ XFAPage()
foxit.addon.xfa.XFAPage.XFAPage |
( |
XFAPage |
other | ) |
|
|
inline |
Constructor, with another XFAPage object.
- Parameters
-
◆ GetDisplayMatrix()
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
-
left | Left position of the transformation area in device coordinate system, commonly in pixels.
|
top | Top position of the transformation area in device coordinate system, commonly in pixels.
|
width | Width of the transformation area in device coordinate system, commonly in pixels.
|
height | Height of the transformation area in device coordinate system, commonly in pixels.
|
rotate | Rotation 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.
◆ GetHeight()
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.
◆ GetWidgetAtDevicePoint()
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
-
matrix | The transformation matrix. Usually this is returned by function addon::xfa::XFAPage::GetDisplayMatrix.
|
device_point | A point in device coordination system.
|
tolerance | Tolerance value. Valid range: 0.0f to 30.0f.
|
- Returns
- An XFA Widget object.
◆ GetWidth()
float foxit.addon.xfa.XFAPage.GetWidth |
( |
| ) |
|
|
inline |
Get the width.
- Returns
- A float value that receives the width of current XFA page.
◆ IsEmpty()
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.