foxit::addon::ofd::OFDDoc类 参考
类 foxit::addon::ofd::OFDDoc 继承关系图:
Public 成员函数 | |
| OFDDoc () | |
| 构造函数。 | |
| OFDDoc (const wchar_t *path, const wchar_t *password) | |
| 构造函数，从现有的OFD文件路径创建。 更多... | |
| OFDDoc (const OFDDoc &other) | |
| 构造函数，使用另一个OFD文档对象。 更多... | |
| OFDPage | GetPage (int index) const |
| 按索引获取OFD页面对象。 更多... | |
| int | GetPageCount () const |
| 获取当前OFD文档的页面数。 更多... | |
| bool | IsEmpty () const |
| 检查当前对象是否为空。 更多... | |
| bool | operator!= (const OFDDoc &other) const |
| 不等于操作符。 更多... | |
| OFDDoc & | operator= (const OFDDoc &other) |
| 赋值操作符。 更多... | |
| bool | operator== (const OFDDoc &other) const |
| 等于操作符。 更多... | |
| void | Release () |
| 释放当前OFD文档对象。 更多... | |
 Public 成员函数 继承自 foxit::Base | |
| FS_HANDLE | Handle () const |
| 获取当前对象的句柄。 更多... | |
详细描述
此类用于获取OFD文档的信息。 请确保在使用此类之前已成功调用 common::Library::InitializeOFDEngine。
构造及析构函数说明
◆ OFDDoc() [1/2]
| foxit::addon::ofd::OFDDoc::OFDDoc | ( | const wchar_t * | path, |
| const wchar_t * | password | ||
| ) |
构造函数，从现有的OFD文件路径创建。
- 参数
-
[in] path 现有OFD文件的完整路径。它不应该是空字符串。 [in] password OFD文件的密码。如果OFD文件未加密，应为空字符串。
◆ OFDDoc() [2/2]
| foxit::addon::ofd::OFDDoc::OFDDoc | ( | const OFDDoc & | other | ) |
构造函数，使用另一个OFD文档对象。
- 参数
-
[in] other 另一个OFD文档对象。
成员函数说明
◆ GetPage()
| OFDPage foxit::addon::ofd::OFDDoc::GetPage | ( | int | index | ) | const |
按索引获取OFD页面对象。
- 参数
-
[in] index 页面的索引。有效范围：从0到(page_count-1)。 page_count 由函数 OFDDoc::GetPageCount 返回。
- 返回
- OFD页面对象。
◆ GetPageCount()
| int foxit::addon::ofd::OFDDoc::GetPageCount | ( | ) | const |
获取当前OFD文档的页面数。
- 返回
- 当前OFD文档的页面数。
◆ IsEmpty()
| bool foxit::addon::ofd::OFDDoc::IsEmpty | ( | ) | const |
检查当前对象是否为空。
当当前对象为空时，意味着当前对象无用。
- 返回
- true 表示当前对象为空，而 false 表示不为空。
◆ operator!=()
| bool foxit::addon::ofd::OFDDoc::operator!= | ( | const OFDDoc & | other | ) | const |
不等于操作符。
- 参数
-
[in] other 另一个OFD文档对象。此函数将检查当前对象是否不等于此对象。
- 返回
- true 表示不相等，而 false 表示相等。
◆ operator=()
赋值操作符。
- 参数
-
[in] other 另一个OFD文档对象，其值将被分配给当前对象。
- 返回
- 对当前对象本身的引用。
◆ operator==()
| bool foxit::addon::ofd::OFDDoc::operator== | ( | const OFDDoc & | other | ) | const |
等于操作符。
- 参数
-
[in] other 另一个OFD文档对象。此函数将检查当前对象是否等于此对象。
- 返回
- true 表示相等，而 false 表示不相等。
◆ Release()
| void foxit::addon::ofd::OFDDoc::Release | ( | ) |
