Foxit PDF SDK

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

## Public 类型
enum | PagingSealAPState { e_PagingSealAPStateUnknown = 0, e_PagingSealAPStateUnsigned = 1, e_PagingSealAPStateSigned = 2, e_PagingSealAPStateValid = 3, e_PagingSealAPStateInvalid = 4 }
| 用于设置外观的分页印章签名状态枚举。 更多...
Public 类型 继承自 foxit::pdf::Signature
enum | APFlags { e_APFlagFoxitFlag = 0x0001, e_APFlagLabel = 0x0002, e_APFlagReason = 0x0004, e_APFlagSigningTime = 0x0008, e_APFlagDN = 0x0010, e_APFlagLocation = 0x0020, e_APFlagSigner = 0x0040, e_APFlagBitmap = 0x0080, e_APFlagText = 0x0100, e_APFlagFoxitEditorFlag = 0x0200, e_APFlagProducer = 0x0400 }
| 签名外观标志的枚举。 更多...
enum | DigestAlgorithm { e_DigestSHA1 = 0, e_DigestSHA256 = 1, e_DigestSHA384 = 2, e_DigestSHA512 = 3 }
| 签名摘要算法的枚举。 更多...
enum | DocPermission { e_DocPermUnrestricted = 0, e_DocPermNoChangesAllowed = 1, e_DocPermFillingFormAndSigning = 2, e_DocPermFillingFormSigningAndAnnotating = 3 }
| 签名文档权限的枚举。 更多...
enum | FieldMDPAction { e_FieldMDPActionNone = 0, e_FieldMDPActionAll = 1, e_FieldMDPActionInclude = 2, e_FieldMDPActionExclude = 3 }
| 签名字段MDP（"MDP"表示修改检测和预防）操作类型的枚举。 更多...
enum | KeyName { e_KeyNameSigner = 0, e_KeyNameLocation = 1, e_KeyNameReason = 2, e_KeyNameContactInfo = 3, e_KeyNameDN = 4, e_KeyNameText = 5, e_KeyNameProducer = 6 }
| 签名键名的枚举。 更多...
enum | LabelName { e_LabelNameSigner = 0, e_LabelNameLocation = 1, e_LabelNameReason = 2, e_LabelNameSignTime = 3, e_LabelNameDN = 4, e_LabelNameProducer = 6 }
| 签名标签名称的枚举。 更多...
enum | PAdESLevel { e_PAdESLevelNotPAdES = 0, e_PAdESLevelNone = 1, e_PAdESLevelBB = 2, e_PAdESLevelBT = 3, e_PAdESLevelBLT = 4, e_PAdESLevelBLTA = 5 }
| PAdES级别的枚举。 更多...
enum | SignatureType { e_SignatureTypeOrdinary = 0, e_SignatureTypeTimeStamp = 3, e_SignatureTypePagingSeal = 4 }
| 签名类型的枚举。 更多...
enum | States { e_StateUnknown = 0x80000000, e_StateNoSignData = 0x00000200, e_StateUnsigned = 0x00000001, e_StateSigned = 0x00000002, e_StateVerifyValid = 0x00000004, e_StateVerifyInvalid = 0x00000008, e_StateVerifyErrorData = 0x00000010, e_StateVerifyNoSupportWay = 0x00000020, e_StateVerifyErrorByteRange = 0x00000040, e_StateVerifyChange = 0x00000080, e_StateVerifyIncredible = 0x00000100, e_StateVerifyNoChange = 0x00000400, e_StateVerifyIssueValid = 0x00001000, e_StateVerifyIssueUnknown = 0x00002000, e_StateVerifyIssueRevoke = 0x00004000, e_StateVerifyIssueExpire = 0x00008000, e_StateVerifyIssueUncheck = 0x00010000, e_StateVerifyIssueCurrent = 0x00020000, e_StateVerifyTimestampNone = 0x00040000, e_StateVerifyTimestampDoc = 0x00080000, e_StateVerifyTimestampValid = 0x00100000, e_StateVerifyTimestampInvalid = 0x00200000, e_StateVerifyTimestampExpire = 0x00400000, e_StateVerifyTimestampIssueUnknown = 0x00800000, e_StateVerifyTimestampIssueValid = 0x01000000, e_StateVerifyTimestampTimeBefore = 0x02000000, e_StateCertCannotGetVRI = 0x04000000, e_StateVerifyChangeLegal = 0x08000000, e_StateVerifyChangeIllegal = 0x10000000 }
| 签名状态的枚举。 更多...
Public 类型 继承自 foxit::pdf::interform::Field
enum | Flags { e_FlagReadOnly = 0x01, e_FlagRequired = 0x02, e_FlagNoExport = 0x04, e_FlagButtonNoToggleToOff = 0x100, e_FlagButtonRadiosInUnison = 0x200, e_FlagTextMultiline = 0x100, e_FlagTextPassword = 0x200, e_FlagTextFileSelect = 0x400, e_FlagTextNoSpellCheck = 0x800, e_FlagTextDoNotScroll = 0x1000, e_FlagTextComb = 0x2000, e_FlagComboEdit = 0x100, e_FlagChoiceMultiSelect = 0x100, e_FlagTextRichText = 0x4000, e_FlagChoiceSort = 0x200, e_FlagChoiceCommitOnSelChange = 0x400 }
| 表单字段标志的枚举。 更多...
enum | Type { e_TypeUnknown = 0, e_TypePushButton = 1, e_TypeCheckBox = 2, e_TypeRadioButton = 3, e_TypeComboBox = 4, e_TypeListBox = 5, e_TypeTextField = 6, e_TypeSignature = 7 }
| 表单字段类型的枚举。 更多...

## Public 成员函数
| ~PagingSealSignature ()
| 析构函数。
bool | GenerateAppearance ()
| 生成分页印章签名的外观。 更多...
void | SetAPStateBitmap (PagingSealAPState ap_state, const common::Bitmap &bitmap)
| 为签名状态的外观设置位图。 更多...
void | SetPagingSealConfig (PagingSealConfig paging_seal_config)
| 设置分页印章签名的配置。 更多...
Public 成员函数 继承自 foxit::pdf::Signature
| Signature (const foxit::pdf::PDFDoc &document, foxit::pdf::objects::PDFDictionary *sig_field_dict)
| 构造函数，从签名字段字典创建。 更多...
| Signature (const interform::Field &field)
| 构造函数，使用父类对象。 更多...
| ~Signature ()
| 析构函数。
bool | ClearSignedData ()
| 如果当前签名已签名且验证有效，清除数据和外观。 更多...
void | EnableEmbedFont (bool enable_embed_font)
| 启用或禁用嵌入字体。 更多...
void | EnableIncrementalSaveForFirstSigning (bool enable_incremental_save)
| 启用或禁用首次签名的增量保存。用户应在调用 函数Signature::StartSign之前调用此函数。 默认值：false。 更多...
bool | GenerateAppearance ()
| 生成未签名签名的外观。 更多...
uint32 | GetAppearanceFlags ()
| 获取签名外观标志。 更多...
common::Bitmap | GetBitmap ()
| 获取用于签名外观的位图。 更多...
bool | GetByteRangeArray (uint32 out_byte_range_array[4])
| 获取字节范围数据，包括4个元素。 更多...
WString | GetCert (int32 index) const
| 通过索引从当前签名的证书链中获取证书。 更多...
int32 | GetCertCount () const
| 获取当前签名证书链中的证书数量。 更多...
String | GetCertificateInfo (const char *key)
| 获取证书信息。 更多...
DocPermission | GetDocPermission ()
| 获取当前签名的文档权限。 更多...
PDFDoc | GetDocument ()
| 获取当前签名所属的PDF文档。 更多...
FieldMDPAction | GetFieldMDPAction ()
| 获取FieldMDP（"MDP"表示修改检测和预防）操作类型。 更多...
WStringArray | GetFieldMDPActionFields ()
| 获取用于FieldMDP操作的字段名称数组。 更多...
String | GetFilter ()
| 获取过滤器。 更多...
WString | GetKeyLabel (LabelName label_name)
| 获取指定键标签的字符串。 更多...
WString | GetKeyValue (KeyName key)
| 获取指定键名的字符串值。 更多...
PAdESLevel | GetPAdESLevel ()
| 获取PAdES级别。 更多...
SignatureArray | GetPagingSealGroupElements ()
| 获取当前分页印章签名的组元素。 更多...
PagingSealSignature | GetPagingSealSignature ()
| 获取分页印章签名。 更多...
objects::PDFDictionary * | GetSignatureDict () const
| 获取签名字典。 更多...
SignatureType | GetSignatureType ()
| 获取签名类型。 更多...
PDFDoc | GetSignedVersionDocument (const wchar_t *file_path)
| 获取当前签名签署时的已签名版本中的PDF文档。 更多...
DateTime | GetSignTime ()
| 获取签名时间。 更多...
uint32 | GetState ()
| 获取当前状态。 更多...
String | GetSubFilter ()
| 获取子过滤器。 更多...
bool | IsEmpty () const
| 检查当前对象是否为空。 更多...
bool | IsSigned ()
| 检查当前签名是否已签名。 更多...
bool | IsTimeStamp ()
| 检查当前签名是否为时间戳签名。 更多...
void | SetAppearanceContent (const String &appearance_content)
| 为已签名签名外观设置自定义外观内容（作为低级绘图操作命令）。 更多...
void | SetAppearanceFlags (uint32 appearance_flags)
| 设置签名外观标志。 更多...
void | SetBitmap (const common::Bitmap &bitmap)
| 为签名外观设置位图。 更多...
void | SetCertChain (const WStringArray &cert_chain)
| 设置证书链。 更多...
void | SetCustomObject (const char *key, objects::PDFObject *pdf_object)
| 为签名字典设置自定义PDF对象。 更多...
void | SetDefaultContentsLength (uint32 default_length)
| 设置表示签名值（称为已签名数据）的签名内容的默认长度。 更多...
void | SetDocPermission (DocPermission permission)
| 设置当前签名的文档权限。 更多...
void | SetFieldMDPActionFields (const FieldMDPAction &action, const WStringArray &field_array)
| 设置FieldMDP（"MDP"表示修改检测和预防）操作名称数组。 更多...
void | SetFilter (const char *filter)
| 设置过滤器。 更多...
void | SetImage (const char *file_path, int frame_index)
| 使用指定帧索引为签名外观设置图像。 更多...
void | SetImage (const common::Image &image, int frame_index)
| 为签名外观设置图像，指定帧索引。 更多...
void | SetImage (const wchar_t *file_path, int frame_index)
| 使用指定帧索引为签名外观设置图像。 更多...
void | SetKeyLabel (LabelName label_name, const wchar_t *label_value)
| 设置指定键标签的字符串。 更多...
void | SetKeyValue (KeyName key, const wchar_t *value)
| 设置指定键名的字符串值。 更多...
void | SetSignTime (const DateTime &sign_time)
| 设置签名时间。 更多...
void | SetSubFilter (const char *sub_filter)
| 设置子过滤器。 更多...
common::Progressive | StartSign (const wchar_t *cert_path, const foxit::WString &cert_password, foxit::pdf::Signature::DigestAlgorithm digest_algorithm, foxit::common::file::StreamCallback *stream_callback, const void *client_data=0, foxit::common::PauseCallback *pause=0)
| 如果当前签名为未签名状态，则开始签名当前签名。 更多...
common::Progressive | StartSign (const wchar_t *cert_path, const WString &cert_password, DigestAlgorithm digest_algorithm, const char *save_path, const void *client_data=0, common::PauseCallback *pause=0)
| 如果当前签名未签名，开始签名当前签名。 更多...
common::Progressive | StartSign (const wchar_t *cert_path, const WString &cert_password, DigestAlgorithm digest_algorithm, const wchar_t *save_path, const void *client_data=0, common::PauseCallback *pause=0)
| 如果当前签名未签名，开始签名当前签名。 更多...
common::Progressive | StartSign (foxit::common::file::StreamCallback *cert_file_stream, const foxit::WString &cert_password, foxit::pdf::Signature::DigestAlgorithm digest_algorithm, foxit::common::file::StreamCallback *stream_callback, const void *client_data=0, foxit::common::PauseCallback *pause=0)
| 如果当前签名为未签名状态，则开始签名当前签名。 更多...
common::Progressive | StartSign (foxit::common::file::StreamCallback *cert_file_stream, const WString &cert_password, DigestAlgorithm digest_algorithm, const char *save_path, const void *client_data=0, common::PauseCallback *pause=0)
| 如果当前签名是未签名的，开始签名当前签名。 更多...
common::Progressive | StartSign (foxit::common::file::StreamCallback *cert_file_stream, const WString &cert_password, DigestAlgorithm digest_algorithm, const wchar_t *save_path, const void *client_data=0, common::PauseCallback *pause=0)
| 如果当前签名是未签名的，开始签名当前签名。 更多...
common::Progressive | StartVerify (const void *client_data=0, common::PauseCallback *pause=0)
| 如果当前签名已签名，开始验证当前签名的完整性。 更多...
Public 成员函数 继承自 foxit::pdf::interform::Field
| Field (const Field &field)
| 构造函数，使用另一个表单字段对象。 更多...
| Field (const PDFDoc &document, objects::PDFDictionary *field_dict)
| 从字段字典构造函数。 更多...
| ~Field ()
| 析构函数。
common::Alignment | GetAlignment () const
| 获取对齐值。 更多...
WString | GetAlternateName () const
| 获取备用名称。 更多...
Control | GetControl (const foxit::pdf::PDFPage &page, int index)
| 在指定PDF页面中通过索引获取表单控件。 更多...
Control | GetControl (int index)
| 通过索引获取表单控件。 更多...
int | GetControlCount () const
| 获取表单控件数量。 更多...
int | GetControlCount (const foxit::pdf::PDFPage &page) const
| 获取指定PDF页面中的表单控件数量。 更多...
DefaultAppearance | GetDefaultAppearance () const
| 获取默认外观数据。 更多...
WString | GetDefaultValue () const
| 获取默认值。 更多...
objects::PDFObject * | GetDefaultValueObj () const
| 获取字段默认值的PDF对象。 更多...
objects::PDFDictionary * | GetDict () const
| 获取当前对象的PDF字典。 更多...
uint32 | GetFlags () const
| 获取字段标志。 更多...
objects::PDFObject * | GetInheritedAttribute (const char *attribute_name) const
| 获取指定属性的PDF对象，该属性可能从字段树中的祖先节点继承。 更多...
WString | GetMappingName () const
| 获取映射名称。 更多...
int | GetMaxLength () const
| 获取字段文本的最大长度（以字符为单位）。 更多...
WString | GetName () const
| 获取字段名称。 更多...
ChoiceOptionArray | GetOptions () const
| 获取列表框或组合框的选项。 更多...
int | GetTopVisibleIndex ()
| 获取可滚动列表框的选项顶部索引。 更多...
Type | GetType () const
| 获取字段类型。 更多...
WString | GetValue () const
| 获取值。 更多...
objects::PDFObject * | GetValueObj () const
| 获取字段值的PDF对象。 更多...
bool | IsEmpty () const
| 检查当前对象是否为空。 更多...
bool | operator!= (const Field &other) const
| 不等于操作符。 更多...
Field & | operator= (const Field &other)
| 赋值操作符。 更多...
bool | operator== (const Field &other) const
| 等于操作符。 更多...
bool | Reset ()
| 将当前字段中的数据重置为其默认值。（不支持签名字段） 更多...
void | SetAlignment (common::Alignment alignment)
| 设置表单的对齐属性，作为文档范围的默认值。（不支持签名字段） 更多...
void | SetAlternateName (const wchar_t *alternate_name)
| 设置备用名称。（不支持签名字段） 更多...
void | SetDefaultAppearance (const DefaultAppearance &default_ap)
| 设置默认外观数据。 更多...
void | SetDefaultValue (const wchar_t *value)
| 设置默认值。 更多...
void | SetFlags (uint32 flags)
| 设置字段标志。 更多...
void | SetMappingName (const wchar_t *name)
| 设置映射名称。（不支持签名字段） 更多...
void | SetMaxLength (int max_length)
| 设置字段文本的最大长度（以字符为单位）。 更多...
void | SetOptions (const ChoiceOptionArray &option_array)
| 设置列表框或组合框的选项。 更多...
void | SetTopVisibleIndex (int index)
| 设置可滚动列表框的顶部索引。 更多...
void | SetValue (const wchar_t *value)
| 设置值。 更多...
Public 成员函数 继承自 foxit::Base
FS_HANDLE | Handle () const
| 获取当前对象的句柄。 更多...

## 详细描述

此类表示用于签署签名的分页印章签名对象。它是一种签名字段类型， 因此类PagingSealSignature派生自类pdf::Signature。 新的分页印章签名对象将由函数PDFDoc::AddPagingSealSignature返回， 而不是PDFPage::AddSignature。
分页印章签名包含几个签名或几个分页印章注释。要设置 分页印章签名的配置，请使用函数PagingSealSignature::SetPagingSealConfig。

## 成员枚举类型说明

## ◆ PagingSealAPState

enum foxit::pdf::PagingSealSignature::PagingSealAPState

用于设置外观的分页印章签名状态枚举。

此枚举的值应单独使用。

枚举值
e_PagingSealAPStateUnknown | 未知签名。
e_PagingSealAPStateUnsigned | 未签名签名。
e_PagingSealAPStateSigned | 已签名签名。
e_PagingSealAPStateValid | 签名的验证状态有效。
e_PagingSealAPStateInvalid | 签名的验证状态无效。

## 成员函数说明

## ◆ GenerateAppearance()

bool foxit::pdf::PagingSealSignature::GenerateAppearance | ( |  | ) |

生成分页印章签名的外观。

此函数应在签名前调用，并且分页印章配置应已设置。 如果不调用此函数，页面将不会显示分页印章签名。

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

## ◆ SetAPStateBitmap()

void foxit::pdf::PagingSealSignature::SetAPStateBitmap | ( | PagingSealAPState | ap_state,
|  | const common::Bitmap & | bitmap
| ) |  |

为签名状态的外观设置位图。

如果用户希望通过此函数的设置对分页印章签名的外观产生效果， 请在此函数之后调用函数PagingSealSignature::GenerateAppearence。

参数

  [in] | ap_state | 签名的状态。
  [in] | bitmap | 要设置到外观的位图。

返回
  None.

## ◆ SetPagingSealConfig()

void foxit::pdf::PagingSealSignature::SetPagingSealConfig | ( | PagingSealConfig | paging_seal_config | ) |

设置分页印章签名的配置。

参数

  [in] | paging_seal_config | 要设置的分页印章配置。

返回
  None.