Foxit PDF SDK

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

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

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

## 详细描述

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

## 成员枚举类型说明

## ◆ PagingSealAPState

enum foxit.pdf.PagingSealSignature.PagingSealAPState
| strong

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

此枚举的值应单独使用。

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

## 成员函数说明

## ◆ GenerateAppearance()

new bool foxit.pdf.PagingSealSignature.GenerateAppearance | ( |  | ) |
| inline

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

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

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

## ◆ SetAPStateBitmap()

void foxit.pdf.PagingSealSignature.SetAPStateBitmap | ( | PagingSealSignature.PagingSealAPState | ap_state,
|  | Bitmap | bitmap
| ) |  |
| inline

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

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

参数

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

返回
  None.

## ◆ SetPagingSealConfig()

void foxit.pdf.PagingSealSignature.SetPagingSealConfig | ( | PagingSealConfig | paging_seal_config | ) |
| inline

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

参数

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

返回
  None.