Foxit PDF SDK

Public 成员函数 | 所有成员列表
foxit::ofd::ofdseal::SealDoc类 参考
类 foxit::ofd::ofdseal::SealDoc 继承关系图:

## Public 成员函数
| SealDoc (OFDDoc doc)
| 带参数的构造函数。 更多...
| SealDoc (const SealDoc &other)
| 构造函数，通过另一个签章文档对象。 更多...
| ~SealDoc ()
| 析构函数。
bool | IsEmpty () const
| 检查当前对象是否为空。 更多...
bool | operator != (const SealDoc &other) const
| 不相等操作符。 更多...
SealDoc & | operator= (const SealDoc &other)
| 赋值操作符。 更多...
bool | operator== (const SealDoc &other) const
| 相等操作符。 更多...
bool | SignWithMultiPage (const Seal &seal, const foxit::Int32Array &page_index_array, const ImagePosition &position, const String &dest_file, const PublicProperties &properties=PublicProperties())
| 在多页相同位置对OFD文档进行签章。 更多...
bool | SignWithMultiPage (const Seal &seal, const foxit::Int32Array &page_index_array, const ImagePosition &position, const WString &dest_file, const PublicProperties &properties=PublicProperties())
| 在多页相同位置对OFD文档进行签章。 更多...
bool | SignWithMultiPage (const Seal &seal, const foxit::Int32Array &page_index_array, const ImagePosition &position, foxit::common::file::WriterCallback *writer_callback, const PublicProperties &properties=PublicProperties())
| 在多页相同位置对OFD文档进行签章。 更多...
bool | SignWithMultiPage (const Seal &seal, const String &page_scope, const ImagePosition &position, const String &dest_file, const PublicProperties &properties=PublicProperties())
| 在多页相同位置对OFD文档进行签章。 更多...
bool | SignWithMultiPage (const Seal &seal, const String &page_scope, const ImagePosition &position, const WString &dest_file, const PublicProperties &properties=PublicProperties())
| 在多页相同位置对OFD文档进行签名或签章。 更多...
bool | SignWithMultiPage (const Seal &seal, const String &page_scope, const ImagePosition &position, foxit::common::file::WriterCallback *writer_callback, const PublicProperties &properties=PublicProperties())
| 在多页相同位置对OFD文档进行签名或签章。 更多...
bool | SignWithMultiPosition (const Seal &seal, const ImagePositionArray &position_array, const String &dest_file, const PublicProperties &properties=PublicProperties())
| 在多位置对OFD文档进行签章。 更多...
bool | SignWithMultiPosition (const Seal &seal, const ImagePositionArray &position_array, const WString &dest_file, const PublicProperties &properties=PublicProperties())
| 在多位置对OFD文档进行签章。 更多...
bool | SignWithMultiPosition (const Seal &seal, const ImagePositionArray &position_array, foxit::common::file::WriterCallback *writer_callback, const PublicProperties &properties=PublicProperties())
| 在多位置对OFD文档进行签章。 更多...
bool | SignWithPage (const Seal &seal, const ImagePosition &position, const String &dest_file, const PublicProperties &properties=PublicProperties())
| 在特定页特定位置对OFD文档进行签章。 更多...
bool | SignWithPage (const Seal &seal, const ImagePosition &position, const WString &dest_file, const PublicProperties &properties=PublicProperties())
| 在特定页特定位置对OFD文档进行签章。 更多...
bool | SignWithPage (const Seal &seal, const ImagePosition &position, foxit::common::file::WriterCallback *writer_callback, const PublicProperties &properties=PublicProperties())
| 在特定页特定位置对OFD文档进行签章。 更多...
bool | SignWithStraddle (const Seal &seal, const StraddlePosition &position, const String &dest_file, const PublicProperties &properties=PublicProperties())
| 在跨页位置对OFD文档进行签章，即骑缝章。 更多...
bool | SignWithStraddle (const Seal &seal, const StraddlePosition &position, const WString &dest_file, const PublicProperties &properties=PublicProperties())
| 在跨页位置对OFD文档进行签章，即骑缝章。 更多...
bool | SignWithStraddle (const Seal &seal, const StraddlePosition &position, foxit::common::file::WriterCallback *writer_callback, const PublicProperties &properties=PublicProperties())
| 在跨页位置对OFD文档进行签章，即骑缝章。 更多...
Public 成员函数 继承自 foxit::Base
FS_HANDLE | Handle () const
| 获取当前对象的句柄。 更多...

## 详细描述

此类表示和OFD签章文档相关的操作。

## 构造及析构函数说明

## ◆ SealDoc() [1/2]

foxit::ofd::ofdseal::SealDoc::SealDoc | ( | OFDDoc | doc | ) |
| explicit

带参数的构造函数。

参数

  [in] | doc | OFD文档对象。

## ◆ SealDoc() [2/2]

foxit::ofd::ofdseal::SealDoc::SealDoc | ( | const SealDoc & | other | ) |

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

参数

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

## 成员函数说明

## ◆ IsEmpty()

bool foxit::ofd::ofdseal::SealDoc::IsEmpty | ( |  | ) | const

检查当前对象是否为空。

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

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

## ◆ operator !=()

bool foxit::ofd::ofdseal::SealDoc::operator != | ( | const SealDoc & | other | ) | const

不相等操作符。

参数

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

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

## ◆ operator=()

SealDoc& foxit::ofd::ofdseal::SealDoc::operator= | ( | const SealDoc & | other | ) |

赋值操作符。

参数

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

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

## ◆ operator==()

bool foxit::ofd::ofdseal::SealDoc::operator== | ( | const SealDoc & | other | ) | const

相等操作符。

参数

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

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

## ◆ SignWithMultiPage() [1/6]

bool foxit::ofd::ofdseal::SealDoc::SignWithMultiPage | ( | const Seal & | seal,
|  | const foxit::Int32Array & | page_index_array,
|  | const ImagePosition & | position,
|  | const String & | dest_file,
|  | const PublicProperties & | properties = `PublicProperties()`
| ) |  |

在多页相同位置对OFD文档进行签章。

参数

  [in] | seal | 签章对象。详见 foxit::ofd::ofdseal::Oes 。
  [in] | page_index_array | 页面索引数组，从0开始。
  [in] | position | 签名或签章图像位置参数。详见 foxit::ofd::ofdseal::ImagePosition 。 此属性中的 foxit::ofd::ofdseal::ImagePosition::page_index 属性将不会生效。
  [in] | dest_file | 签章后保存的目标文件路径。
  [in] | properties | 签章的公共属性参数，默认值为空属性。详见 foxit::ofd::ofdseal::PublicProperties 。

返回
  true表示签章成功，false表示签章失败。

## ◆ SignWithMultiPage() [2/6]

bool foxit::ofd::ofdseal::SealDoc::SignWithMultiPage | ( | const Seal & | seal,
|  | const foxit::Int32Array & | page_index_array,
|  | const ImagePosition & | position,
|  | const WString & | dest_file,
|  | const PublicProperties & | properties = `PublicProperties()`
| ) |  |

在多页相同位置对OFD文档进行签章。

参数

  [in] | seal | 签章对象。详见 foxit::ofd::ofdseal::Oes 。
  [in] | page_index_array | 页面索引数组，从0开始。
  [in] | position | 签名或签章图像位置参数。详见 foxit::ofd::ofdseal::ImagePosition 。 此属性中的 foxit::ofd::ofdseal::ImagePosition::page_index 属性将不会生效。
  [in] | dest_file | 签章后保存的目标文件路径。
  [in] | properties | 签章的公共属性参数，默认值为空属性。详见 foxit::ofd::ofdseal::PublicProperties 。

返回
  true表示签章成功，false表示签章失败。

## ◆ SignWithMultiPage() [3/6]

bool foxit::ofd::ofdseal::SealDoc::SignWithMultiPage | ( | const Seal & | seal,
|  | const foxit::Int32Array & | page_index_array,
|  | const ImagePosition & | position,
|  | foxit::common::file::WriterCallback * | writer_callback,
|  | const PublicProperties & | properties = `PublicProperties()`
| ) |  |

在多页相同位置对OFD文档进行签章。

参数

  [in] | seal | 签章对象。详见 foxit::ofd::ofdseal::Oes 。
  [in] | page_index_array | 页面索引数组，从0开始。
  [in] | position | 签名或签章图像位置参数。详见 foxit::ofd::ofdseal::ImagePosition 。 此属性中的 foxit::ofd::ofdseal::ImagePosition::page_index 属性将不会生效。
  [in] | writer_callback | 用户实现的 common::file::WriterCallback 对象，用于保存签名或签章后的文件。
  [in] | properties | 签章的公共属性参数，默认值为空属性。详见 foxit::ofd::ofdseal::PublicProperties 。

返回
  true表示签章成功，false表示签章失败。

## ◆ SignWithMultiPage() [4/6]

bool foxit::ofd::ofdseal::SealDoc::SignWithMultiPage | ( | const Seal & | seal,
|  | const String & | page_scope,
|  | const ImagePosition & | position,
|  | const String & | dest_file,
|  | const PublicProperties & | properties = `PublicProperties()`
| ) |  |

在多页相同位置对OFD文档进行签章。

参数

  [in] | seal | 签章对象。详见 foxit::ofd::ofdseal::Oes 。
  [in] | page_scope | 页面索引范围，从0开始。如下格式的字符串 "0-10,35,50-" 分别表示: 0~10页、35页、50页到最后一页。 "0-"，表示全部页面。
  [in] | position | 签名或签章图像位置参数。详见 foxit::ofd::ofdseal::ImagePosition 。 此属性中的 foxit::ofd::ofdseal::ImagePosition::page_index 属性将不会生效。
  [in] | dest_file | 签名或签章后保存的目标文件路径。
  [in] | properties | 签名或签章的公共属性参数，默认值为空属性。详见 foxit::ofd::ofdseal::PublicProperties 。

返回
  true表示签名或签章成功，false表示签名或签章失败。

## ◆ SignWithMultiPage() [5/6]

bool foxit::ofd::ofdseal::SealDoc::SignWithMultiPage | ( | const Seal & | seal,
|  | const String & | page_scope,
|  | const ImagePosition & | position,
|  | const WString & | dest_file,
|  | const PublicProperties & | properties = `PublicProperties()`
| ) |  |

在多页相同位置对OFD文档进行签名或签章。

参数

  [in] | seal | 签章对象。详见 foxit::ofd::ofdseal::Oes 。
  [in] | page_scope | 页面索引范围，从0开始。如下格式的字符串 "0-10,35,50-" 分别表示: 0~10页、35页、50页到最后一页。 "0-"，表示全部页面。
  [in] | position | 签名或签章图像位置参数。详见 foxit::ofd::ofdseal::ImagePosition 。 此属性中的 foxit::ofd::ofdseal::ImagePosition::page_index 属性将不会生效。
  [in] | dest_file | 签名或签章后保存的目标文件路径。
  [in] | properties | 签名或签章的公共属性参数，默认值为空属性。详见 foxit::ofd::ofdseal::PublicProperties 。

返回
  true表示签名或签章成功，false表示签名或签章失败。

## ◆ SignWithMultiPage() [6/6]

bool foxit::ofd::ofdseal::SealDoc::SignWithMultiPage | ( | const Seal & | seal,
|  | const String & | page_scope,
|  | const ImagePosition & | position,
|  | foxit::common::file::WriterCallback * | writer_callback,
|  | const PublicProperties & | properties = `PublicProperties()`
| ) |  |

在多页相同位置对OFD文档进行签名或签章。

参数

  [in] | seal | 签章对象。详见 foxit::ofd::ofdseal::Oes 。
  [in] | page_scope | 页面索引范围，从0开始。如下格式的字符串 "0-10,35,50-" 分别表示: 0~10页、35页、50页到最后一页。 "0-"，表示全部页面。
  [in] | position | 签名或签章图像位置参数。详见 foxit::ofd::ofdseal::ImagePosition 。 此属性中的 foxit::ofd::ofdseal::ImagePosition::page_index 属性将不会生效。
  [in] | writer_callback | 用户实现的 common::file::WriterCallback 对象，用于保存签名或签章后的文件。
  [in] | properties | 签名或签章的公共属性参数，默认值为空属性。详见 foxit::ofd::ofdseal::PublicProperties 。

返回
  true表示签名或签章成功，false表示签名或签章失败。

## ◆ SignWithMultiPosition() [1/3]

bool foxit::ofd::ofdseal::SealDoc::SignWithMultiPosition | ( | const Seal & | seal,
|  | const ImagePositionArray & | position_array,
|  | const String & | dest_file,
|  | const PublicProperties & | properties = `PublicProperties()`
| ) |  |

在多位置对OFD文档进行签章。

参数

  [in] | seal | 签章对象。详见 foxit::ofd::ofdseal::Oes 。
  [in] | position_array | 签名或签章图像位置参数数组。详见 foxit::ofd::ofdseal::ImagePositionArray 。
  [in] | dest_file | 签章后保存的目标文件路径。
  [in] | properties | 签章的公共属性参数，默认值为空属性。详见 foxit::ofd::ofdseal::PublicProperties 。

返回
  true表示签章成功，false表示签章失败。

## ◆ SignWithMultiPosition() [2/3]

bool foxit::ofd::ofdseal::SealDoc::SignWithMultiPosition | ( | const Seal & | seal,
|  | const ImagePositionArray & | position_array,
|  | const WString & | dest_file,
|  | const PublicProperties & | properties = `PublicProperties()`
| ) |  |

在多位置对OFD文档进行签章。

参数

  [in] | seal | 签章对象。详见 foxit::ofd::ofdseal::Oes 。
  [in] | position_array | 签名或签章图像位置参数数组。详见 foxit::ofd::ofdseal::ImagePositionArray 。
  [in] | dest_file | 签章后保存的目标文件路径。
  [in] | properties | 签章的公共属性参数，默认值为空属性。详见 foxit::ofd::ofdseal::PublicProperties 。

返回
  true表示签章成功，false表示签章失败。

## ◆ SignWithMultiPosition() [3/3]

bool foxit::ofd::ofdseal::SealDoc::SignWithMultiPosition | ( | const Seal & | seal,
|  | const ImagePositionArray & | position_array,
|  | foxit::common::file::WriterCallback * | writer_callback,
|  | const PublicProperties & | properties = `PublicProperties()`
| ) |  |

在多位置对OFD文档进行签章。

参数

  [in] | seal | 签章对象。详见 foxit::ofd::ofdseal::Oes 。
  [in] | position_array | 签名或签章图像位置参数数组。详见 foxit::ofd::ofdseal::ImagePositionArray 。
  [in] | writer_callback | 用户实现的 common::file::WriterCallback 对象，用于保存签名或签章后的文件。
  [in] | properties | 签章的公共属性参数，默认值为空属性。详见 foxit::ofd::ofdseal::PublicProperties 。

返回
  true表示签章成功，false表示签章失败。

## ◆ SignWithPage() [1/3]

bool foxit::ofd::ofdseal::SealDoc::SignWithPage | ( | const Seal & | seal,
|  | const ImagePosition & | position,
|  | const String & | dest_file,
|  | const PublicProperties & | properties = `PublicProperties()`
| ) |  |

在特定页特定位置对OFD文档进行签章。

参数

  [in] | seal | 签章对象。详见 foxit::ofd::ofdseal::Oes 。
  [in] | position | 签名或签章图像位置参数。详见 foxit::ofd::ofdseal::ImagePosition 。
  [in] | dest_file | 签章后保存的目标文件路径。
  [in] | properties | 签章的公共属性参数，默认值为空属性。详见 foxit::ofd::ofdseal::PublicProperties 。

返回
  true 表示签章成功，false 表示签章失败。

## ◆ SignWithPage() [2/3]

bool foxit::ofd::ofdseal::SealDoc::SignWithPage | ( | const Seal & | seal,
|  | const ImagePosition & | position,
|  | const WString & | dest_file,
|  | const PublicProperties & | properties = `PublicProperties()`
| ) |  |

在特定页特定位置对OFD文档进行签章。

参数

  [in] | seal | 签章对象。详见 foxit::ofd::ofdseal::Oes 。
  [in] | position | 签名或签章图像位置参数。详见 foxit::ofd::ofdseal::ImagePosition 。
  [in] | dest_file | 签章后保存的目标文件路径。
  [in] | properties | 签章的公共属性参数，默认值为空属性。详见 foxit::ofd::ofdseal::PublicProperties 。

返回
  true 表示签章成功，false 表示签章失败。

## ◆ SignWithPage() [3/3]

bool foxit::ofd::ofdseal::SealDoc::SignWithPage | ( | const Seal & | seal,
|  | const ImagePosition & | position,
|  | foxit::common::file::WriterCallback * | writer_callback,
|  | const PublicProperties & | properties = `PublicProperties()`
| ) |  |

在特定页特定位置对OFD文档进行签章。

参数

  [in] | seal | 签章对象。详见 foxit::ofd::ofdseal::Oes 。
  [in] | position | 签名或签章图像位置参数。详见 foxit::ofd::ofdseal::ImagePosition 。
  [in] | writer_callback | 用户实现的 common::file::WriterCallback 对象，用于保存签名或签章后的文件。
  [in] | properties | 签章的公共属性参数，默认值为空属性。详见 foxit::ofd::ofdseal::PublicProperties 。

返回
  true 表示签章成功，false 表示签章失败。

## ◆ SignWithStraddle() [1/3]

bool foxit::ofd::ofdseal::SealDoc::SignWithStraddle | ( | const Seal & | seal,
|  | const StraddlePosition & | position,
|  | const String & | dest_file,
|  | const PublicProperties & | properties = `PublicProperties()`
| ) |  |

在跨页位置对OFD文档进行签章，即骑缝章。

参数

  [in] | seal | 签章对象。详见 foxit::ofd::ofdseal::Oes 。
  [in] | position | 骑缝章位置参数。详见 foxit::ofd::ofdseal::StraddlePosition 。
  [in] | dest_file | 签章后保存的目标文件路径。
  [in] | properties | 签章的公共属性参数，默认值为空属性。详见 foxit::ofd::ofdseal::PublicProperties 。

返回
  true表示签章成功，false表示签章失败。

## ◆ SignWithStraddle() [2/3]

bool foxit::ofd::ofdseal::SealDoc::SignWithStraddle | ( | const Seal & | seal,
|  | const StraddlePosition & | position,
|  | const WString & | dest_file,
|  | const PublicProperties & | properties = `PublicProperties()`
| ) |  |

在跨页位置对OFD文档进行签章，即骑缝章。

参数

  [in] | seal | 签章对象。详见 foxit::ofd::ofdseal::Oes 。
  [in] | position | 骑缝章位置参数。详见 foxit::ofd::ofdseal::StraddlePosition 。
  [in] | dest_file | 签章后保存的目标文件路径。
  [in] | properties | 签章的公共属性参数，默认值为空属性。详见 foxit::ofd::ofdseal::PublicProperties 。

返回
  true表示签章成功，false表示签章失败。

## ◆ SignWithStraddle() [3/3]

bool foxit::ofd::ofdseal::SealDoc::SignWithStraddle | ( | const Seal & | seal,
|  | const StraddlePosition & | position,
|  | foxit::common::file::WriterCallback * | writer_callback,
|  | const PublicProperties & | properties = `PublicProperties()`
| ) |  |

在跨页位置对OFD文档进行签章，即骑缝章。

参数

  [in] | seal | 签章对象。详见 foxit::ofd::ofdseal::Oes 。
  [in] | position | 骑缝章位置参数。详见 foxit::ofd::ofdseal::StraddlePosition 。
  [in] | writer_callback | 用户实现的 common::file::WriterCallback 对象，用于保存签名或签章后的文件。
  [in] | properties | 签章的公共属性参数，默认值为空属性。详见 foxit::ofd::ofdseal::PublicProperties 。

返回
  true表示签章成功，false表示签章失败。