Foxit PDF SDK

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

## Public 成员函数
| CertificateSignDoc (OFDDoc doc, const String &cert_file, const String &cert_password)
| 带参数的构造函数。 更多...
| CertificateSignDoc (OFDDoc doc, const WString &cert_file, const String &cert_password)
| 带参数的构造函数。 更多...
| CertificateSignDoc (const CertificateSignDoc &other)
| 构造函数，通过另一个签名文档对象。 更多...
| ~CertificateSignDoc ()
| 析构函数。
bool | IsEmpty () const
| 检查当前对象是否为空。 更多...
bool | operator != (const CertificateSignDoc &other) const
| 不相等操作符。 更多...
CertificateSignDoc & | operator= (const CertificateSignDoc &other)
| 赋值操作符。 更多...
bool | operator== (const CertificateSignDoc &other) const
| 相等操作符。 更多...
bool | SignWithImage (const String &image_file, const ImagePosition &position, const String &dest_file, const SignatureProperties &signature_properties=SignatureProperties(), const PublicProperties &properties=PublicProperties())
| 对OFD文档进行数字签名，并添加签名图像。 更多...
bool | SignWithImage (const WString &image_file, const ImagePosition &position, const WString &dest_file, const SignatureProperties &signature_properties=SignatureProperties(), const PublicProperties &properties=PublicProperties())
| 对OFD文档进行数字签名，并添加签名图像。 更多...
bool | SignWithImage (const String &image_file, const ImagePosition &position, foxit::common::file::WriterCallback *writer_callback, const SignatureProperties &signature_properties=SignatureProperties(), const PublicProperties &properties=PublicProperties())
| 对OFD文档进行数字签名，并添加签名图像。 更多...
bool | SignWithNone (const String &dest_file, const SignatureProperties &signature_properties=SignatureProperties(), const PublicProperties &properties=PublicProperties())
| 对OFD文档进行数字签名，但不添加签名图像。 更多...
bool | SignWithNone (const WString &dest_file, const SignatureProperties &signature_properties=SignatureProperties(), const PublicProperties &properties=PublicProperties())
| 对OFD文档进行数字签名，但不添加签名图像。 更多...
bool | SignWithNone (foxit::common::file::WriterCallback *writer_callback, const SignatureProperties &signature_properties=SignatureProperties(), const PublicProperties &properties=PublicProperties())
| 对OFD文档进行数字签名，但不添加签名图像。 更多...
bool | SignWithStraddle (const String &image_file, float image_width, float image_height, const StraddlePosition &position, const String &dest_file, const SignatureProperties &signature_properties=SignatureProperties(), const PublicProperties &properties=PublicProperties())
| 对OFD文档进行数字签名，并添加跨页签名图像，即骑缝章。 更多...
bool | SignWithStraddle (const WString &image_file, float image_width, float image_height, const StraddlePosition &position, const WString &dest_file, const SignatureProperties &signature_properties=SignatureProperties(), const PublicProperties &properties=PublicProperties())
| 对OFD文档进行数字签名，并添加跨页签名图像，即骑缝章。 更多...
bool | SignWithStraddle (const String &image_file, float image_width, float image_height, const StraddlePosition &position, foxit::common::file::WriterCallback *writer_callback, const SignatureProperties &signature_properties=SignatureProperties(), const PublicProperties &properties=PublicProperties())
| 对OFD文档进行数字签名，并添加跨页签名图像，即骑缝章。 更多...
Public 成员函数 继承自 foxit::Base
FS_HANDLE | Handle () const
| 获取当前对象的句柄。 更多...

## 详细描述

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

## 构造及析构函数说明

## ◆ CertificateSignDoc() [1/3]

foxit::ofd::ofdseal::CertificateSignDoc::CertificateSignDoc | ( | OFDDoc | doc,
|  | const String & | cert_file,
|  | const String & | cert_password
| ) |  |
| explicit

带参数的构造函数。

参数

  [in] | doc | OFD文档对象。
  [in] | cert_file | 签名证书文件路径。
  [in] | cert_password | 签名证书密码。

## ◆ CertificateSignDoc() [2/3]

foxit::ofd::ofdseal::CertificateSignDoc::CertificateSignDoc | ( | OFDDoc | doc,
|  | const WString & | cert_file,
|  | const String & | cert_password
| ) |  |
| explicit

带参数的构造函数。

参数

  [in] | doc | OFD文档对象。
  [in] | cert_file | 签名证书文件路径。
  [in] | cert_password | 签名证书密码。

## ◆ CertificateSignDoc() [3/3]

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

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

参数

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

## 成员函数说明

## ◆ IsEmpty()

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

检查当前对象是否为空。

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

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

## ◆ operator !=()

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

不相等操作符。

参数

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

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

## ◆ operator=()

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

赋值操作符。

参数

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

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

## ◆ operator==()

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

相等操作符。

参数

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

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

## ◆ SignWithImage() [1/3]

bool foxit::ofd::ofdseal::CertificateSignDoc::SignWithImage | ( | const String & | image_file,
|  | const ImagePosition & | position,
|  | const String & | dest_file,
|  | const SignatureProperties & | signature_properties = `SignatureProperties()`,
|  | const PublicProperties & | properties = `PublicProperties()`
| ) |  |

对OFD文档进行数字签名，并添加签名图像。

参数

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

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

## ◆ SignWithImage() [2/3]

bool foxit::ofd::ofdseal::CertificateSignDoc::SignWithImage | ( | const WString & | image_file,
|  | const ImagePosition & | position,
|  | const WString & | dest_file,
|  | const SignatureProperties & | signature_properties = `SignatureProperties()`,
|  | const PublicProperties & | properties = `PublicProperties()`
| ) |  |

对OFD文档进行数字签名，并添加签名图像。

参数

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

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

## ◆ SignWithImage() [3/3]

bool foxit::ofd::ofdseal::CertificateSignDoc::SignWithImage | ( | const String & | image_file,
|  | const ImagePosition & | position,
|  | foxit::common::file::WriterCallback * | writer_callback,
|  | const SignatureProperties & | signature_properties = `SignatureProperties()`,
|  | const PublicProperties & | properties = `PublicProperties()`
| ) |  |

对OFD文档进行数字签名，并添加签名图像。

参数

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

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

## ◆ SignWithNone() [1/3]

bool foxit::ofd::ofdseal::CertificateSignDoc::SignWithNone | ( | const String & | dest_file,
|  | const SignatureProperties & | signature_properties = `SignatureProperties()`,
|  | const PublicProperties & | properties = `PublicProperties()`
| ) |  |

对OFD文档进行数字签名，但不添加签名图像。

参数

  [in] | dest_file | 签名后保存的目标文件路径。
  [in] | signature_properties | 签名属性参数。默认值为空属性。详见 foxit::ofd::ofdseal::SignatureProperties 。
  [in] | properties | 签名的公共属性参数。默认值为空属性。详见 foxit::ofd::ofdseal::PublicProperties 。

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

## ◆ SignWithNone() [2/3]

bool foxit::ofd::ofdseal::CertificateSignDoc::SignWithNone | ( | const WString & | dest_file,
|  | const SignatureProperties & | signature_properties = `SignatureProperties()`,
|  | const PublicProperties & | properties = `PublicProperties()`
| ) |  |

对OFD文档进行数字签名，但不添加签名图像。

参数

  [in] | dest_file | 签名后保存的目标文件路径。
  [in] | signature_properties | 签名属性参数。默认值为空属性。详见 foxit::ofd::ofdseal::SignatureProperties 。
  [in] | properties | 签名的公共属性参数。默认值为空属性。详见 foxit::ofd::ofdseal::PublicProperties 。

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

## ◆ SignWithNone() [3/3]

bool foxit::ofd::ofdseal::CertificateSignDoc::SignWithNone | ( | foxit::common::file::WriterCallback * | writer_callback,
|  | const SignatureProperties & | signature_properties = `SignatureProperties()`,
|  | const PublicProperties & | properties = `PublicProperties()`
| ) |  |

对OFD文档进行数字签名，但不添加签名图像。

参数

  [in] | writer_callback | 用户实现的 common::file::WriterCallback 对象，用于保存签名后的文件。
  [in] | signature_properties | 签名属性参数。默认值为空属性。详见 foxit::ofd::ofdseal::SignatureProperties 。
  [in] | properties | 签名的公共属性参数。默认值为空属性。详见 foxit::ofd::ofdseal::PublicProperties 。

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

## ◆ SignWithStraddle() [1/3]

bool foxit::ofd::ofdseal::CertificateSignDoc::SignWithStraddle | ( | const String & | image_file,
|  | float | image_width,
|  | float | image_height,
|  | const StraddlePosition & | position,
|  | const String & | dest_file,
|  | const SignatureProperties & | signature_properties = `SignatureProperties()`,
|  | const PublicProperties & | properties = `PublicProperties()`
| ) |  |

对OFD文档进行数字签名，并添加跨页签名图像，即骑缝章。

参数

  [in] | image_file | 签名图像文件路径。
  [in] | image_width | 签名图像宽度，单位为毫米。
  [in] | image_height | 签名图像高度，单位为毫米
  [in] | position | 骑缝章位置参数，详见 foxit::ofd::ofdseal::StraddlePosition 。
  [in] | dest_file | 签名后保存的目标文件路径。
  [in] | signature_properties | 签名属性参数。默认值为空属性。详见 foxit::ofd::ofdseal::SignatureProperties 。
  [in] | properties | 签名的公共属性参数。默认值为空属性。详见 foxit::ofd::ofdseal::PublicProperties 。

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

## ◆ SignWithStraddle() [2/3]

bool foxit::ofd::ofdseal::CertificateSignDoc::SignWithStraddle | ( | const WString & | image_file,
|  | float | image_width,
|  | float | image_height,
|  | const StraddlePosition & | position,
|  | const WString & | dest_file,
|  | const SignatureProperties & | signature_properties = `SignatureProperties()`,
|  | const PublicProperties & | properties = `PublicProperties()`
| ) |  |

对OFD文档进行数字签名，并添加跨页签名图像，即骑缝章。

参数

  [in] | image_file | 签名图像文件路径。
  [in] | image_width | 签名图像宽度，单位为毫米。
  [in] | image_height | 签名图像高度，单位为毫米
  [in] | position | 骑缝章位置参数，详见 foxit::ofd::ofdseal::StraddlePosition 。
  [in] | dest_file | 签名后保存的目标文件路径。
  [in] | signature_properties | 签名属性参数。默认值为空属性。详见 foxit::ofd::ofdseal::SignatureProperties 。
  [in] | properties | 签名的公共属性参数。默认值为空属性。详见 foxit::ofd::ofdseal::PublicProperties 。

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

## ◆ SignWithStraddle() [3/3]

bool foxit::ofd::ofdseal::CertificateSignDoc::SignWithStraddle | ( | const String & | image_file,
|  | float | image_width,
|  | float | image_height,
|  | const StraddlePosition & | position,
|  | foxit::common::file::WriterCallback * | writer_callback,
|  | const SignatureProperties & | signature_properties = `SignatureProperties()`,
|  | const PublicProperties & | properties = `PublicProperties()`
| ) |  |

对OFD文档进行数字签名，并添加跨页签名图像，即骑缝章。

参数

  [in] | image_file | 签名图像文件路径。
  [in] | image_width | 签名图像宽度，单位为毫米。
  [in] | image_height | 签名图像高度，单位为毫米
  [in] | position | 骑缝章位置参数，详见 foxit::ofd::ofdseal::StraddlePosition 。
  [in] | writer_callback | 用户实现的 common::file::WriterCallback 对象，用于保存签名后的文件。
  [in] | signature_properties | 签名属性参数。默认值为空属性。详见 foxit::ofd::ofdseal::SignatureProperties 。
  [in] | properties | 签名的公共属性参数。默认值为空属性。详见 foxit::ofd::ofdseal::PublicProperties 。

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