Foxit PDF SDK

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

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

## 静态 Public 属性
| e_PagingSealAPStateInvalid = _fsdk.PagingSealSignature_e_PagingSealAPStateInvalid
| 签名的验证状态无效。
| e_PagingSealAPStateSigned = _fsdk.PagingSealSignature_e_PagingSealAPStateSigned
| 已签名签名。
| e_PagingSealAPStateUnknown = _fsdk.PagingSealSignature_e_PagingSealAPStateUnknown
| 未知签名。
| e_PagingSealAPStateUnsigned = _fsdk.PagingSealSignature_e_PagingSealAPStateUnsigned
| 未签名签名。
| e_PagingSealAPStateValid = _fsdk.PagingSealSignature_e_PagingSealAPStateValid
| 签名的验证状态有效。
静态 Public 属性 继承自 FoxitPDFSDKPython3.Signature
| e_APFlagBitmap = _fsdk.Signature_e_APFlagBitmap
| 如果设置，在签名外观上显示位图。
| e_APFlagDN = _fsdk.Signature_e_APFlagDN
| 如果设置，在签名外观上显示专有名称。
| e_APFlagFoxitEditorFlag = _fsdk.Signature_e_APFlagFoxitEditorFlag
| 如果设置，在签名外观上显示Foxit Editor内容。
| e_APFlagFoxitFlag = _fsdk.Signature_e_APFlagFoxitFlag
| 如果设置，在签名外观上显示Foxit标志。
| e_APFlagLabel = _fsdk.Signature_e_APFlagLabel
| 如果设置，在签名外观上显示标签。
| e_APFlagLocation = _fsdk.Signature_e_APFlagLocation
| 如果设置，在签名外观上显示位置。
| e_APFlagProducer = _fsdk.Signature_e_APFlagProducer
| 如果设置，在签名外观上显示生产者内容。
| e_APFlagReason = _fsdk.Signature_e_APFlagReason
| 如果设置，在签名外观上显示原因。
| e_APFlagSigner = _fsdk.Signature_e_APFlagSigner
| 如果设置，在签名外观上显示签名者。
| e_APFlagSigningTime = _fsdk.Signature_e_APFlagSigningTime
| 如果设置，在签名外观上显示签名时间。
| e_APFlagText = _fsdk.Signature_e_APFlagText
| 如果设置，在签名外观上显示文本内容。
| e_DigestSHA1 = _fsdk.Signature_e_DigestSHA1
| 签名摘要算法：sha1算法。
| e_DigestSHA256 = _fsdk.Signature_e_DigestSHA256
| 签名摘要算法：sha256算法。
| e_DigestSHA384 = _fsdk.Signature_e_DigestSHA384
| 签名摘要算法：sha384算法。
| e_DigestSHA512 = _fsdk.Signature_e_DigestSHA512
| 签名摘要算法：sha512算法。
| e_DocPermFillingFormAndSigning = _fsdk.Signature_e_DocPermFillingFormAndSigning
| 允许的更改是填写表单、实例化页面模板和签名。 其他更改将使签名无效。
| e_DocPermFillingFormSigningAndAnnotating = _fsdk.Signature_e_DocPermFillingFormSigningAndAnnotating
| 允许的更改与2相同，以及创建、删除和修改注释。 其他更改将使签名无效。
| e_DocPermNoChangesAllowed = _fsdk.Signature_e_DocPermNoChangesAllowed
| 不允许对PDF文档（被签名签署）进行任何更改。 对此类PDF文档的任何更改都将使签名无效。
| e_DocPermUnrestricted = _fsdk.Signature_e_DocPermUnrestricted
| 无限制。
| e_FieldMDPActionAll = _fsdk.Signature_e_FieldMDPActionAll
| 所有表单字段的标志将被设置为只读。
| e_FieldMDPActionExclude = _fsdk.Signature_e_FieldMDPActionExclude
| 表单字段（除指定表单字段外）的标志将被设置为只读。 更多...
| e_FieldMDPActionInclude = _fsdk.Signature_e_FieldMDPActionInclude
| 指定表单字段的标志将被设置为只读。 更多...
| e_FieldMDPActionNone = _fsdk.Signature_e_FieldMDPActionNone
| 无字段MDP操作。
| e_KeyNameContactInfo = _fsdk.Signature_e_KeyNameContactInfo
| 签名键名：联系信息。
| e_KeyNameDN = _fsdk.Signature_e_KeyNameDN
| 签名键名：专有名称。
| e_KeyNameLocation = _fsdk.Signature_e_KeyNameLocation
| 签名键名：位置。
| e_KeyNameProducer = _fsdk.Signature_e_KeyNameProducer
| 签名键名：生产者内容。
| e_KeyNameReason = _fsdk.Signature_e_KeyNameReason
| 签名键名：原因。
| e_KeyNameSigner = _fsdk.Signature_e_KeyNameSigner
| 签名键名：签名者。
| e_KeyNameText = _fsdk.Signature_e_KeyNameText
| 签名键名：文本内容。
| e_LabelNameDN = _fsdk.Signature_e_LabelNameDN
| 专有名称的签名键名。 更多...
| e_LabelNameLocation = _fsdk.Signature_e_LabelNameLocation
| 位置的签名标签名称。 更多...
| e_LabelNameProducer = _fsdk.Signature_e_LabelNameProducer
| 生产者名称的签名键名。 更多...
| e_LabelNameReason = _fsdk.Signature_e_LabelNameReason
| 原因的签名标签名称。 更多...
| e_LabelNameSigner = _fsdk.Signature_e_LabelNameSigner
| 签名者的签名标签名称。 更多...
| e_LabelNameSignTime = _fsdk.Signature_e_LabelNameSignTime
| 签名时间的签名标签名称。 更多...
| e_PAdESLevelBB = _fsdk.Signature_e_PAdESLevelBB
| PAdES级别：B-B。
| e_PAdESLevelBLT = _fsdk.Signature_e_PAdESLevelBLT
| PAdES级别：B-LT。
| e_PAdESLevelBLTA = _fsdk.Signature_e_PAdESLevelBLTA
| PAdES级别：B-LTA。
| e_PAdESLevelBT = _fsdk.Signature_e_PAdESLevelBT
| PAdES级别：B-T。
| e_PAdESLevelNone = _fsdk.Signature_e_PAdESLevelNone
| PAdES级别：无。
| e_PAdESLevelNotPAdES = _fsdk.Signature_e_PAdESLevelNotPAdES
| 不是PAdES签名。
| e_SignatureTypeOrdinary = _fsdk.Signature_e_SignatureTypeOrdinary
| 签名类型：普通。
| e_SignatureTypePagingSeal = _fsdk.Signature_e_SignatureTypePagingSeal
| 签名类型：分页印章。
| e_SignatureTypeTimeStamp = _fsdk.Signature_e_SignatureTypeTimeStamp
| 签名类型：时间戳。
| e_StateCertCannotGetVRI = _fsdk.Signature_e_StateCertCannotGetVRI
| 无法获取验证相关信息。
| e_StateNoSignData = _fsdk.Signature_e_StateNoSignData
| 签名没有任何用于签名的数据。这意味着签名字典中没有"V"条目。
| e_StateSigned = _fsdk.Signature_e_StateSigned
| 已签名的签名。
| e_StateUnknown = _fsdk.Signature_e_StateUnknown
| 未知签名。
| e_StateUnsigned = _fsdk.Signature_e_StateUnsigned
| 未签名的签名。
| e_StateVerifyChange = _fsdk.Signature_e_StateVerifyChange
| 文档在签名范围内已被更改。（这表示签名无效。）
| e_StateVerifyChangeIllegal = _fsdk.Signature_e_StateVerifyChangeIllegal
| 文档在签名范围之外已被更改，并且更改使签名无效。
| e_StateVerifyChangeLegal = _fsdk.Signature_e_StateVerifyChangeLegal
| 文档在签名范围之外已被更改，但更改是被允许的。
| e_StateVerifyErrorByteRange = _fsdk.Signature_e_StateVerifyErrorByteRange
| 非预期字节范围。
| e_StateVerifyErrorData = _fsdk.Signature_e_StateVerifyErrorData
| 签名数据已损坏（这意味着签名数据无法正确解析）。
| e_StateVerifyIncredible = _fsdk.Signature_e_StateVerifyIncredible
| 签名不可信（包含攻击性）。
| e_StateVerifyInvalid = _fsdk.Signature_e_StateVerifyInvalid
| 签名的验证状态无效。
| e_StateVerifyIssueCurrent = _fsdk.Signature_e_StateVerifyIssueCurrent
| 验证的发行者是当前发行者。
| e_StateVerifyIssueExpire = _fsdk.Signature_e_StateVerifyIssueExpire
| 用于验证发行者的证书已过期。
| e_StateVerifyIssueRevoke = _fsdk.Signature_e_StateVerifyIssueRevoke
| 用于验证发行者的证书已被撤销。
| e_StateVerifyIssueUncheck = _fsdk.Signature_e_StateVerifyIssueUncheck
| 不检查发行者。
| e_StateVerifyIssueUnknown = _fsdk.Signature_e_StateVerifyIssueUnknown
| 发行者的验证状态未知。
| e_StateVerifyIssueValid = _fsdk.Signature_e_StateVerifyIssueValid
| 发行者的验证状态有效。
| e_StateVerifyNoChange = _fsdk.Signature_e_StateVerifyNoChange
| 文档在签名范围内未被更改。
| e_StateVerifyNoSupportWay = _fsdk.Signature_e_StateVerifyNoSupportWay
| 不支持的签名。
| e_StateVerifyTimestampDoc = _fsdk.Signature_e_StateVerifyTimestampDoc
| 签名是时间戳签名。
| e_StateVerifyTimestampExpire = _fsdk.Signature_e_StateVerifyTimestampExpire
| 时间戳的验证状态已过期。
| e_StateVerifyTimestampInvalid = _fsdk.Signature_e_StateVerifyTimestampInvalid
| 时间戳的验证状态无效。
| e_StateVerifyTimestampIssueUnknown = _fsdk.Signature_e_StateVerifyTimestampIssueUnknown
| 时间戳发行者的验证状态未知。
| e_StateVerifyTimestampIssueValid = _fsdk.Signature_e_StateVerifyTimestampIssueValid
| 时间戳发行者的验证状态有效。
| e_StateVerifyTimestampNone = _fsdk.Signature_e_StateVerifyTimestampNone
| 没有时间戳或不检查时间戳。
| e_StateVerifyTimestampTimeBefore = _fsdk.Signature_e_StateVerifyTimestampTimeBefore
| 时间戳时间的验证状态有效，因为时间在过期日期之前。
| e_StateVerifyTimestampValid = _fsdk.Signature_e_StateVerifyTimestampValid
| 时间戳的验证状态有效。
| e_StateVerifyValid = _fsdk.Signature_e_StateVerifyValid
| 签名的验证状态有效。
静态 Public 属性 继承自 FoxitPDFSDKPython3.Field
| e_FlagButtonNoToggleToOff = _fsdk.Field_e_FlagButtonNoToggleToOff
| （仅对单选按钮有用）如果设置，必须始终选择一个单选按钮； 点击当前选择的按钮没有效果。如果清除，点击选择的按钮会取消选择它， 不留下任何选择的按钮。
| e_FlagButtonRadiosInUnison = _fsdk.Field_e_FlagButtonRadiosInUnison
| （仅对单选按钮有用）如果设置，单选按钮字段内使用相同开启状态值的 一组单选按钮将一致地开启和关闭；也就是如果一个被选中，它们都被选中。 如果清除，按钮是互斥的。
| e_FlagChoiceCommitOnSelChange = _fsdk.Field_e_FlagChoiceCommitOnSelChange
| （仅对选择字段有用）如果设置，一旦用指点设备进行选择，新值就立即提交； 如果清除，新值直到用户退出字段时才提交。
| e_FlagChoiceMultiSelect = _fsdk.Field_e_FlagChoiceMultiSelect
| （仅对列表框有用）如果设置，可以同时选择多个项目； if clear, no more than one item at a time may be selected.
| e_FlagChoiceSort = _fsdk.Field_e_FlagChoiceSort
| （仅对选择字段有用）如果设置，字段的选项项应按字母顺序排序。
| e_FlagComboEdit = _fsdk.Field_e_FlagComboEdit
| （仅对组合框有用）如果设置，组合框包括带有下拉列表的可编辑文本控件， 如果清除，它只包括下拉列表。
| e_FlagNoExport = _fsdk.Field_e_FlagNoExport
| 如果设置，字段不能由提交表单操作导出。
| e_FlagReadOnly = _fsdk.Field_e_FlagReadOnly
| 如果设置，用户不能更改字段的值。任何关联的控件注释将不会 与用户交互；也就是说，它们不会响应鼠标点击或响应鼠标移动而改变外观。 此标志对于其值被计算或从数据库导入的字段很有用。
| e_FlagRequired = _fsdk.Field_e_FlagRequired
| 如果设置，字段在由提交表单操作导出时必须有一个值。
| e_FlagTextComb = _fsdk.Field_e_FlagTextComb
| （仅对文本字段有用）如果设置，使用梳状格式。 更多...
| e_FlagTextDoNotScroll = _fsdk.Field_e_FlagTextDoNotScroll
| （仅对文本字段有用）如果设置，字段不滚动（单行字段水平滚动， 多行字段垂直滚动）以容纳超出其注释矩形的更多文本。 一旦字段满了，就不再接受更多文本。
| e_FlagTextFileSelect = _fsdk.Field_e_FlagTextFileSelect
| （仅对文本字段有用）如果设置，在字段中输入的文本表示文件的路径名， 其内容将作为字段的值提交。
| e_FlagTextMultiline = _fsdk.Field_e_FlagTextMultiline
| （仅对文本字段有用）如果设置，文本字段可以包含多行文本； 如果清除，字段的文本限制为单行。
| e_FlagTextNoSpellCheck = _fsdk.Field_e_FlagTextNoSpellCheck
| （仅对文本字段有用）如果设置，在字段中输入的文本不进行拼写检查。
| e_FlagTextPassword = _fsdk.Field_e_FlagTextPassword
| （仅对文本字段有用）如果设置，字段用于输入不应在屏幕上可见回显的安全密码。 从键盘输入的字符应该以某种不可读的形式回显，例如星号或项目符号字符。 更多...
| e_FlagTextRichText = _fsdk.Field_e_FlagTextRichText
| （仅对文本字段有用）如果设置，此字段的值应表示为富文本字符串。
| e_TypeCheckBox = _fsdk.Field_e_TypeCheckBox
| 表单字段类型：复选框。
| e_TypeComboBox = _fsdk.Field_e_TypeComboBox
| 表单字段类型：组合框。
| e_TypeListBox = _fsdk.Field_e_TypeListBox
| 表单字段类型：列表框。
| e_TypePushButton = _fsdk.Field_e_TypePushButton
| 表单字段类型：按钮。
| e_TypeRadioButton = _fsdk.Field_e_TypeRadioButton
| 表单字段类型：单选按钮。
| e_TypeSignature = _fsdk.Field_e_TypeSignature
| 表单字段类型：签名字段。
| e_TypeTextField = _fsdk.Field_e_TypeTextField
| 表单字段类型：文本字段。
| e_TypeUnknown = _fsdk.Field_e_TypeUnknown
| 表单字段类型：未知。

## 详细描述

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

## 成员函数说明

## ◆ GenerateAppearance()

def FoxitPDFSDKPython3.PagingSealSignature.GenerateAppearance | ( |  | ) |

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

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

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

重载 FoxitPDFSDKPython3.Signature .

## ◆ SetAPStateBitmap()

def FoxitPDFSDKPython3.PagingSealSignature.SetAPStateBitmap | ( |  | ap_state,
|  |  | bitmap
| ) |  |

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

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

参数

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

返回
  None.

## ◆ SetPagingSealConfig()

def FoxitPDFSDKPython3.PagingSealSignature.SetPagingSealConfig | ( |  | paging_seal_config | ) |

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

参数

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

返回
  None.