Foxit PDF SDK

Public 类型 | Public 成员函数 | 所有成员列表
foxit::fld::FLDDoc类 参考
类 foxit::fld::FLDDoc 继承关系图:

## Public 类型
enum | FLDType { e_FLDTypeUnknown = 0, e_FLDTypePDF = 1, e_FLDTypeOFD = 2 }
| FLD文档类型枚举类型. 更多...

## Public 成员函数
| FLDDoc (const char *path)
| 构造函数。 更多...
| FLDDoc (const wchar_t *path)
| 构造函数。 更多...
| FLDDoc (const void *buffer, size_t size)
| 构造函数。 更多...
| FLDDoc (const FLDDoc &other)
| 构造函数，通过另一个FLD文档对象。 更多...
| ~FLDDoc ()
| 析构函数。
String | GetDocType () const
| 获取FLD文档类型。 更多...
FLDType | GetFLDType () const
| 获取FLD文档FLD类型。 更多...
FLDPage | GetPage (int page_index) const
| 获取FLD文档页面。 更多...
int | GetPageCount () const
| 获取FLD文档页面数量。 更多...
String | GetVersion () const
| 获取FLD文档版本。 更多...
bool | IsEmpty () const
| 检查当前对象是否为空。 更多...
ErrorCode | Load (const String &password="") const
| 加载FLD文档。 更多...
bool | operator != (const FLDDoc &other) const
| 不相等操作符。 更多...
FLDDoc & | operator= (const FLDDoc &other)
| 赋值操作符。 更多...
bool | operator== (const FLDDoc &other) const
| 相等操作符。 更多...
bool | SaveAs (const char *path) const
| 保存FLD文档到指定路径。 更多...
bool | SaveAs (const wchar_t *path) const
| 保存FLD文档到指定路径。 更多...
Public 成员函数 继承自 foxit::Base
FS_HANDLE | Handle () const
| 获取当前对象的句柄。 更多...

## 详细描述

此类表示和FLD文档相关的方法。 在使用“FLD”模块之前，请确保已通过 common::Library::Initialize 函数成功初始化 Foxit PDF SDK。 如果使用FLD打开OFD文档，请确保初始化时使用的密钥包含“OFD”模块。

@详见 common::Library

## 成员枚举类型说明

## ◆ FLDType

enum foxit::fld::FLDDoc::FLDType

FLD文档类型枚举类型.

该枚举值应单独使用。

枚举值
e_FLDTypeUnknown | 未知的FLD类型。
e_FLDTypePDF | PDF类型的FLD文档。
e_FLDTypeOFD | OFD类型的FLD文档。

## 构造及析构函数说明

## ◆ FLDDoc() [1/4]

foxit::fld::FLDDoc::FLDDoc | ( | const char * | path | ) |
| explicit

构造函数。

参数

  [in] | path | FLD文档路径。此路径不应该是空字符串。

## ◆ FLDDoc() [2/4]

foxit::fld::FLDDoc::FLDDoc | ( | const wchar_t * | path | ) |
| explicit

构造函数。

参数

  [in] | path | FLD文档路径。此路径不应该是空字符串。

## ◆ FLDDoc() [3/4]

foxit::fld::FLDDoc::FLDDoc | ( | const void * | buffer,
|  | size_t | size
| ) |  |
| explicit

构造函数。

参数

  [in] | buffer | FLD文档内存缓冲区。此缓冲区不应该是空指针。
  [in] | size | 内存缓冲区大小。

## ◆ FLDDoc() [4/4]

foxit::fld::FLDDoc::FLDDoc | ( | const FLDDoc & | other | ) |

构造函数，通过另一个FLD文档对象。

参数

  [in] | other | 另一个FLD文档对象。

## 成员函数说明

## ◆ GetDocType()

String foxit::fld::FLDDoc::GetDocType | ( |  | ) | const

获取FLD文档类型。

返回
  FLD文档类型。

## ◆ GetFLDType()

FLDType foxit::fld::FLDDoc::GetFLDType | ( |  | ) | const

获取FLD文档FLD类型。

返回
  FLD文档FLD类型。

## ◆ GetPage()

FLDPage foxit::fld::FLDDoc::GetPage | ( | int | page_index | ) | const

获取FLD文档页面。

参数

  [in] | page_index | 页面索引。有效范围：从0到(count-1)。 count 由函数 FLDDoc::GetPageCount 返回。

返回
  FLD文档页面对象。

## ◆ GetPageCount()

int foxit::fld::FLDDoc::GetPageCount | ( |  | ) | const

获取FLD文档页面数量。

返回
  FLD文档页面数量。

## ◆ GetVersion()

String foxit::fld::FLDDoc::GetVersion | ( |  | ) | const

获取FLD文档版本。

返回
  FLD文档版本。

## ◆ IsEmpty()

bool foxit::fld::FLDDoc::IsEmpty | ( |  | ) | const

检查当前对象是否为空。

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

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

## ◆ Load()

ErrorCode foxit::fld::FLDDoc::Load | ( | const String & | password = `""` | ) | const

加载FLD文档。

返回
  错误码，表示加载结果。

## ◆ operator !=()

bool foxit::fld::FLDDoc::operator != | ( | const FLDDoc & | other | ) | const

不相等操作符。

参数

  [in] | other | 另一个FLD文档对象。此函数将检查当前对象是否不等于这个对象。

返回
  true 表示不相等，false 表示相等。

## ◆ operator=()

FLDDoc& foxit::fld::FLDDoc::operator= | ( | const FLDDoc & | other | ) |

赋值操作符。

参数

  [in] | other | 另一个FLD文档对象，其值将被赋给当前对象。

返回
  当前对象自身的引用。

## ◆ operator==()

bool foxit::fld::FLDDoc::operator== | ( | const FLDDoc & | other | ) | const

相等操作符。

参数

  [in] | other | 另一个FLD文档对象。此函数将检查当前对象是否等于这个对象。

返回
  true 表示相等，false 表示不相等。

## ◆ SaveAs() [1/2]

bool foxit::fld::FLDDoc::SaveAs | ( | const char * | path | ) | const

保存FLD文档到指定路径。

参数

  [in] | path | FLD文档保存路径。此路径不应该是空字符串。

返回
  true表示保存成功，false表示保存失败。

## ◆ SaveAs() [2/2]

bool foxit::fld::FLDDoc::SaveAs | ( | const wchar_t * | path | ) | const

保存FLD文档到指定路径。

参数

  [in] | path | FLD文档保存路径。此路径不应该是空字符串。

返回
  true表示保存成功，false表示保存失败。