Foxit PDF SDK

Public 成员函数 | 所有成员列表
FSDK::XFAPage类 参考

## Public 成员函数
| etWidgetCount ()
| 获取 XFA 小部件的数量。 更多...
| GetDisplayMatrix (left, top, width, height, rotate)
| 获取显示矩阵，从 PDF 坐标系到目标设备坐标系。 更多...
| GetFirstWidget ()
| 获取当前制表符顺序中的第一个 XFA 小部件。 更多...
| GetHeight ()
| 获取 XFA 页面的高度。 更多...
| GetIndex ()
| 获取 XFA 页面的索引。 更多...
| GetLastWidget ()
| 获取当前制表符顺序中的最后一个 XFA 小部件。 更多...
| GetNextWidget (widget)
| 获取当前制表符顺序中指定 XFA 小部件的下一个 XFA 小部件。 更多...
| GetPrevWidget (widget)
| 获取当前制表符顺序中指定 XFA 小部件的上一个 XFA 小部件。 更多...
| GetWidget (widget_index)
| 按索引获取 XFA 小部件。 更多...
| GetWidgetAtDevicePoint (matrix, device_point, tolerance)
| 在设备坐标系中获取指定点处的 XFA 小部件。 更多...
| GetWidgetByFullName (full_name)
| 获取当前 XFA 页面中与指定完整名称匹配的 XFA 小部件。 更多...
| GetWidth ()
| 获取宽度。 更多...
| IsEmpty ()
| 检查当前对象是否为空。 更多...

## 详细描述

类 FSDK.XFAPage 表示从 XFA 文档对象检索的 XFA 页面。
要渲染 XFA 页面，请使用函数 FSDK.Renderer.StartRenderXFAPage。

参见
  FSDK.Renderer

## 成员函数说明

## ◆ etWidgetCount()

FSDK::XFAPage::etWidgetCount | ( |  | ) |

获取 XFA 小部件的数量。

返回
  XFA 小部件的数量。

## ◆ GetDisplayMatrix()

FSDK::XFAPage::GetDisplayMatrix | ( | left | ,
|  | top | ,
|  | width | ,
|  | height | ,
|  | rotate |
| ) |  |

获取显示矩阵，从 PDF 坐标系到目标设备坐标系。

参数

  [in] | left | 设备坐标系中转换区域的左侧位置，通常以像素为单位。
  [in] | top | 设备坐标系中转换区域的顶部位置，通常以像素为单位。
  [in] | width | 设备坐标系中转换区域的宽度，通常以像素为单位。
  [in] | height | 设备坐标系中转换区域的高度，通常以像素为单位。
  [in] | rotate | 旋转值。请参阅从 FSDK.e_Rotation0 开始的值， 并且该值应为这些值之一。

返回
  一个接收当前 XFA 页面使用的显示矩阵的 Matrix 对象。 如果出现任何错误，将返回所有值为 0 的 Matrix。

## ◆ GetFirstWidget()

FSDK::XFAPage::GetFirstWidget | ( |  | ) |

获取当前制表符顺序中的第一个 XFA 小部件。

返回
  第一个 XFA 小部件。如果返回的 XFA 小部件对象的函数 FSDK.XFAWidget.IsEmpty 的返回值为 true，则表示没有 XFA 小部件。

## ◆ GetHeight()

FSDK::XFAPage::GetHeight | ( |  | ) |

获取 XFA 页面的高度。

返回
  接收当前 XFA 页面高度的浮点值。

## ◆ GetIndex()

FSDK::XFAPage::GetIndex | ( |  | ) |

获取 XFA 页面的索引。

返回
  XFA 页面的索引。

## ◆ GetLastWidget()

FSDK::XFAPage::GetLastWidget | ( |  | ) |

获取当前制表符顺序中的最后一个 XFA 小部件。

返回
  最后一个 XFA 小部件。如果返回的 XFA 小部件对象的函数 FSDK.XFAWidget.IsEmpty 的返回值为 true，则表示没有 XFA 小部件。

## ◆ GetNextWidget()

FSDK::XFAPage::GetNextWidget | ( | widget |  | ) |

获取当前制表符顺序中指定 XFA 小部件的下一个 XFA 小部件。

参数

  [in] | widget | 有效的指定 XFA 小部件。

返回
  下一个 XFA 小部件。如果返回的 XFA 小部件对象的函数 FSDK.XFAWidget.IsEmpty 的返回值为 true，则表示指定的 XFA 小部件是当前制表符顺序中的最后一个 XFA 小部件。

## ◆ GetPrevWidget()

FSDK::XFAPage::GetPrevWidget | ( | widget |  | ) |

获取当前制表符顺序中指定 XFA 小部件的上一个 XFA 小部件。

参数

  [in] | widget | 有效的指定 XFA 小部件。

返回
  上一个 XFA 小部件。如果返回的 XFA 小部件对象的函数 FSDK.XFAWidget.IsEmpty 的返回值为 true，则表示指定的 XFA 小部件是当前制表符顺序中的第一个 XFA 小部件。

## ◆ GetWidget()

FSDK::XFAPage::GetWidget | ( | widget_index |  | ) |

按索引获取 XFA 小部件。

参数

  [in] | widget_index | XFA 小部件索引。有效范围：从 0 到 (count-1)。 count 由函数 FSDK.XFAPage.GetWidgetCount 返回。

返回
  XFA 小部件。

## ◆ GetWidgetAtDevicePoint()

FSDK::XFAPage::GetWidgetAtDevicePoint | ( | matrix | ,
|  | device_point | ,
|  | tolerance |
| ) |  |

在设备坐标系中获取指定点处的 XFA 小部件。

参数

  [in] | matrix | 转换矩阵。通常由函数 FSDK.XFAPage.GetDisplayMatrix 返回。
  [in] | device_point | 设备坐标系中的点。
  [in] | tolerance | 容差值。有效范围：0.0f 到 30.0f。

返回
  XFA 小部件对象。

## ◆ GetWidgetByFullName()

FSDK::XFAPage::GetWidgetByFullName | ( | full_name |  | ) |

获取当前 XFA 页面中与指定完整名称匹配的 XFA 小部件。

参数

  [in] | full_name | XFA 小部件的完整名称。它不应为空字符串。 XFA 小部件的完整名称可以通过函数 FSDK.XFAWidget.GetName 使用类型 FSDK.XFAWidget.e_WidgetNameTypeFullName 在之前的过程中检索。

返回
  XFA 小部件对象。

## ◆ GetWidth()

FSDK::XFAPage::GetWidth | ( |  | ) |

获取宽度。

返回
  接收当前 XFA 页面宽度的浮点值。

## ◆ IsEmpty()

FSDK::XFAPage::IsEmpty | ( |  | ) |

检查当前对象是否为空。

当当前对象为空时，表示当前对象无用。

返回
  true 表示当前对象为空，而 false 表示不为空。