Foxit PDF SDK

Public 成员函数 | 静态 Public 属性 | 所有成员列表
FSDK::PagingSealSignature类 参考
类 FSDK::PagingSealSignature 继承关系图:

## Public 成员函数
| GenerateAppearance ()
| 生成骑缝章签名的外观。 更多...
| SetAPStateBitmap (ap_state, bitmap)
| 为签名状态的外观设置位图。 更多...
| SetPagingSealConfig (paging_seal_config)
| 设置骑缝章签名的配置。 更多...
Public 成员函数 继承自 FSDK::Signature
| ClearSignedData ()
| 如果当前签名已签名并验证有效,则清除数据和外观。 更多...
| constructor (field)
| 使用父类对象的构造函数。 更多...
| constructor (document, sig_field_dict)
| 从签名字段字典构造的构造函数。 更多...
| EnableEmbedFont (enable_embed_font)
| 启用或禁用嵌入字体。 更多...
| EnableIncrementalSaveForFirstSigning (enable_incremental_save)
| 启用或禁用首次签署的增量保存。用户应在调用函数 FSDK.Signature.StartSign之前调用此函数。 默认值：false。 更多...
| GenerateAppearance ()
| 生成未签署签名的外观。 更多...
| GetAppearanceFlags ()
| 获取签名外观标志。 更多...
| GetBitmap ()
| 获取用于签名外观的位图。 更多...
| GetByteRangeArray (out_byte_range_array:[number, number, number, number])
| 获取字节范围数据，包含4个元素。 更多...
| GetCert (index)
| 通过索引从当前签名的证书链中获取证书。 更多...
| GetCertCount ()
| 获取当前签名证书链中的证书数量。 更多...
| GetCertificateInfo (key)
| 获取证书信息。 更多...
| GetDocPermission ()
| 获取当前签名的文档权限。 更多...
| GetDocument ()
| 获取当前签名所属的PDF文档。 更多...
| GetFieldMDPAction ()
| 获取FieldMDP（"MDP"表示修改检测和防止）操作类型。 更多...
| GetFieldMDPActionFields ()
| 获取用于FieldMDP操作的字段名数组。 更多...
| GetFilter ()
| 获取过滤器。 更多...
| GetKeyLabel (label_name)
| 获取指定键标签的字符串。 更多...
| GetKeyValue (key)
| 获取指定键名的字符串值。 更多...
| GetPAdESLevel ()
| 获取PAdES级别。 更多...
| GetPagingSealGroupElements ()
| 获取当前骑缝章签名的组元素。 更多...
| GetPagingSealSignature ()
| 获取骑缝章签名。 更多...
| GetSignatureDict ()
| 获取签名字典。 更多...
| GetSignatureType ()
| 获取签名类型。 更多...
| GetSignedVersionDocument (file_path)
| 获取当前签名被签署时的已签名版本PDF文档。 更多...
| GetSignTime ()
| 获取签署时间。 更多...
| GetState ()
| Get current state. 更多...
| GetSubFilter ()
| 获取子过滤器。 更多...
| IsEmpty ()
| 检查当前对象是否为空。 更多...
| IsSigned ()
| 检查当前签名是否已签署。 更多...
| IsTimeStamp ()
| 检查当前签名是否为时间戳签名。 更多...
| SetAppearanceContent (appearance_content)
| 为已签名签名外观设置自定义外观内容（作为低级绘图操作命令）。 更多...
| SetAppearanceFlags (appearance_flags)
| 设置签名外观标志。 更多...
| SetBitmap (bitmap)
| 为签名外观设置位图。 更多...
| SetCertChain (cert_chain)
| 设置证书链。 更多...
| SetCustomObject (key, pdf_object)
| 为签名字典设置自定义PDF对象。 更多...
| SetDefaultContentsLength (default_length)
| 设置表示签名值（称为已签名数据）的签名内容的默认长度。 更多...
| SetDocPermission (permission)
| 为当前签名设置文档权限。 更多...
| SetFieldMDPActionFields (action, field_array)
| 设置FieldMDP（"MDP"表示修改检测和防止）操作名称数组。 更多...
| SetFilter (filter)
| 设置过滤器。 更多...
| SetImage (image, frame_index)
| 为签名外观设置带有指定帧索引的图像。 更多...
| SetImage (file_path, frame_index)
| 为签名外观设置带有指定帧索引的图像。 更多...
| SetKeyLabel (label_name, label_value)
| 设置指定键标签的字符串。 更多...
| SetKeyValue (key, value)
| 设置指定键名的字符串值。 更多...
| SetSignTime (sign_time)
| 设置签署时间。 更多...
| SetSubFilter (sub_filter)
| 设置子过滤器。 更多...
| StartSign (cert_path, cert_password, digest_algorithm, save_path, client_data, pause)
| 如果当前签名未签署，则开始签署当前签名。 更多...
| StartSign (cert_file_stream, cert_password, digest_algorithm, save_path, client_data, pause)
| 如果当前签名未签署，则开始签署当前签名。 更多...
| StartSign (cert_path, cert_password, digest_algorithm, stream_callback, client_data, pause)
| 如果当前签名未签署，则开始签署当前签名。 更多...
| StartVerify (client_data, pause)
| 如果当前签名已签署，则开始验证当前签名的完整性。 更多...

## 静态 Public 属性
static | e_PagingSealAPStateInvalid
| 签名的验证状态为无效。
static | e_PagingSealAPStateSigned
| 已签名签名。
static | e_PagingSealAPStateUnknown
| 用于设置外观的骑缝章签名状态的枚举。 更多...
static | e_PagingSealAPStateUnsigned
| 未签名签名。
static | e_PagingSealAPStateValid
| 签名的验证状态为有效。
静态 Public 属性 继承自 FSDK::Signature
static | e_APFlagBitmap
| 如果设置，在签名外观上显示位图。
static | e_APFlagDN
| 如果设置，在签名外观上显示可分辨名称。
static | e_APFlagFoxitEditorFlag
| 如果设置，在签名外观上显示Foxit Editor内容。
static | e_APFlagFoxitFlag
| 签名外观标志的枚举。 更多...
static | e_APFlagLabel
| 如果设置，在签名外观上显示标签。
static | e_APFlagLocation
| 如果设置，在签名外观上显示位置。
static | e_APFlagProducer
| 如果设置，在签名外观上显示生产者内容。
static | e_APFlagReason
| 如果设置，在签名外观上显示原因。
static | e_APFlagSigner
| 如果设置，在签名外观上显示签署者。
static | e_APFlagSigningTime
| 如果设置，在签名外观上显示签署时间。
static | e_APFlagText
| 如果设置，在签名外观上显示文本内容。
static | e_DigestSHA1
| 签名摘要算法的枚举。 更多...
static | e_DigestSHA256
| 签名摘要算法：sha256算法。
static | e_DigestSHA384
| 签名摘要算法：sha384算法。
static | e_DigestSHA512
| 签名摘要算法：sha512算法。
static | e_DocPermFillingFormAndSigning
| 允许的更改包括填写表单、实例化页面模板和签名。 其他更改将使签名无效。
static | e_DocPermFillingFormSigningAndAnnotating
| 允许的更改与2相同，以及注释的创建、删除和修改。 其他更改将使签名无效。
static | e_DocPermNoChangesAllowed
| 不允许对PDF文档（由签名签署的文档）进行任何更改。 对这种PDF文档的任何更改都将使签名无效。
static | e_DocPermUnrestricted
| 签名文档权限的枚举。 更多...
static | e_FieldMDPActionAll
| 所有表单字段的标志将被设置为只读。
static | e_FieldMDPActionExclude
| 表单字段（指定表单字段除外）的标志将被设置为只读。 更多...
static | e_FieldMDPActionInclude
| 指定表单字段的标志将被设置为只读。 更多...
static | e_FieldMDPActionNone
| 签名FieldMDP（"MDP"表示修改检测和防止）操作类型的枚举。 更多...
static | e_KeyNameContactInfo
| 签名键名：联系信息。
static | e_KeyNameDN
| 签名键名：可分辨名称。
static | e_KeyNameLocation
| 签名键名：位置。
static | e_KeyNameProducer
| 签名键名：生产者内容。
static | e_KeyNameReason
| 签名键名：原因。
static | e_KeyNameSigner
| 签名键名的枚举。 更多...
static | e_KeyNameText
| 签名键名：文本内容。
static | e_LabelNameDN
| 可分辨名称的签名键名。 更多...
static | e_LabelNameLocation
| 位置的签名标签名。 更多...
static | e_LabelNameProducer
| 生产者名称的签名键名。 更多...
static | e_LabelNameReason
| 原因的签名标签名。 更多...
static | e_LabelNameSigner
| 签名标签名的枚举。 更多...
static | e_LabelNameSignTime
| 签署时间的签名标签名。 更多...
static | e_PAdESLevelBB
| PAdES级别：B-B。
static | e_PAdESLevelBLT
| PAdES级别：B-LT。
static | e_PAdESLevelBLTA
| PAdES级别：B-LTA。
static | e_PAdESLevelBT
| PAdES级别：B-T。
static | e_PAdESLevelNone
| PAdES级别：无。
static | e_PAdESLevelNotPAdES
| PAdES级别的枚举。 更多...
static | e_SignatureTypeOrdinary
| 签名类型的枚举。 更多...
static | e_SignatureTypePagingSeal
| 签名类型：骑缝章签名。
static | e_SignatureTypeTimeStamp
| 签名类型：时间戳签名。
static | e_StateCertCannotGetVRI
| 无法获取验证相关信息。
static | e_StateNoSignData
| 签名没有任何签名数据。这意味着签名字典中没有"V"条目。
static | e_StateSigned
| 已签名的签名。
static | e_StateUnknown
| 签名状态的枚举。 更多...
static | e_StateUnsigned
| 未签名的签名。
static | e_StateVerifyChange
| 文档已在签名范围内被修改。(这表示签名无效。)
static | e_StateVerifyChangeIllegal
| 文档已在签名范围外被修改,且修改使签名无效。
static | e_StateVerifyChangeLegal
| 文档已在签名范围外被修改,但修改是允许的。
static | e_StateVerifyErrorByteRange
| 非期望的字节范围。
static | e_StateVerifyErrorData
| 签名数据已损坏(这意味着签名数据无法正确解析)。
static | e_StateVerifyIncredible
| 签名不可信(包含攻击性)。
static | e_StateVerifyInvalid
| 签名的验证状态无效。
static | e_StateVerifyIssueCurrent
| 验证的发行者是当前发行者。
static | e_StateVerifyIssueExpire
| 用于验证发行者的证书已过期。
static | e_StateVerifyIssueRevoke
| 用于验证发行者的证书已被撤销。
static | e_StateVerifyIssueUncheck
| 未检查发行者。
static | e_StateVerifyIssueUnknown
| 发行者的验证状态未知。
static | e_StateVerifyIssueValid
| 发行者的验证状态有效。
static | e_StateVerifyNoChange
| 文档在签名范围内未被修改。
static | e_StateVerifyTimestampDoc
| 签名是时间戳签名。
static | e_StateVerifyTimestampExpire
| 时间戳的验证状态已过期。
static | e_StateVerifyTimestampInvalid
| 时间戳的验证状态无效。
static | e_StateVerifyTimestampIssueUnknown
| 时间戳发行者的验证状态未知。
static | e_StateVerifyTimestampIssueValid
| 时间戳发行者的验证状态有效。
static | e_StateVerifyTimestampNone
| 没有时间戳或未检查时间戳。
static | e_StateVerifyTimestampTimeBefore
| 时间戳时间的验证状态有效,因为时间在过期日期之前。
static | e_StateVerifyTimestampValid
| 时间戳的验证状态有效。
static | e_StateVerifyValid
| 签名的验证状态有效。

## 额外继承的成员函数
Public 属性 继承自 FSDK::Signature
| e_StateVerifyNoSupportWay
| 不支持的签名。

## 详细描述

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

## 成员函数说明

## ◆ GenerateAppearance()

FSDK::PagingSealSignature::GenerateAppearance | ( |  | ) |

生成骑缝章签名的外观。

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

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

## ◆ SetAPStateBitmap()

FSDK::PagingSealSignature::SetAPStateBitmap | ( | ap_state | ,
|  | bitmap |
| ) |  |

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

如果用户希望此函数的设置对骑缝章签名的外观生效， 请在此函数之后调用函数 FSDK.PagingSealSignature.GenerateAppearence。

参数

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

返回
  无。

## ◆ SetPagingSealConfig()

FSDK::PagingSealSignature::SetPagingSealConfig | ( | paging_seal_config |  | ) |

设置骑缝章签名的配置。

参数

  [in] | paging_seal_config | 要设置的骑缝章配置。

返回
  无。

## 类成员变量说明

## ◆ e_PagingSealAPStateUnknown

FSDK::PagingSealSignature::e_PagingSealAPStateUnknown
| static

用于设置外观的骑缝章签名状态的枚举。

此枚举的值应单独使用。未知签名。