Foxit PDF SDK
FSDK.PagingSealSignature Class Reference
Inheritance diagram for FSDK.PagingSealSignature:
FSDK.Signature

Public Member Functions

 GenerateAppearance ()
 Generate the appearance of paging seal signature. More...
 
 SetAPStateBitmap (ap_state, bitmap)
 Set a bitmap for the appearance of signature state. More...
 
 SetPagingSealConfig (paging_seal_config)
 Set the config of paging seal signature. More...
 
- Public Member Functions inherited from FSDK.Signature
 ClearSignedData ()
 Clear the data and appearance if current signature is singed and verified valid. More...
 
 constructor (document, sig_field_dict)
 Constructor, from signature field dictionary. More...
 
 constructor (field)
 Constructor, with parent class object. More...
 
 EnableEmbedFont (enable_embed_font)
 Enable or disable embed font. More...
 
 EnableIncrementalSaveForFirstSigning (enable_incremental_save)
 Enable or disable incremental save for first signing. User should call this function before calling function FSDK.Signature.StartSign.
Default: false. More...
 
 GenerateAppearance ()
 Generate the appearance of unsigned signature. More...
 
 GetAppearanceFlags ()
 Get signature appearance flags. More...
 
 GetBitmap ()
 Get a bitmap which is used for the signature appearance. More...
 
 GetByteRangeArray (out_byte_range_array:[number, number, number, number])
 Get the byte ranges data, including 4 elements. More...
 
 GetCert (index)
 Get a certificate from current signature's certificate chain by index. More...
 
 GetCertCount ()
 Get the count of certificates in current signature's certificate chain. More...
 
 GetCertificateInfo (key)
 Get certificate information. More...
 
 GetDocPermission ()
 Get document permission for current signature. More...
 
 GetDocument ()
 Get the PDF document, which current signature belongs to. More...
 
 GetFieldMDPAction ()
 Get FieldMDP("MDP" means modification detection and prevention) action type. More...
 
 GetFieldMDPActionFields ()
 Get the field name array which is used for FieldMDP action. More...
 
 GetFilter ()
 Get filter. More...
 
 GetKeyLabel (label_name)
 Get the string for specified key label. More...
 
 GetKeyValue (key)
 Get the string value for specified key name. More...
 
 GetPAdESLevel ()
 Get PAdES level. More...
 
 GetPagingSealGroupElements ()
 Get the group elements of current paging seal signature. More...
 
 GetPagingSealSignature ()
 Get the paging seal signature. More...
 
 GetSignatureDict ()
 Get signature dictionary. More...
 
 GetSignatureType ()
 Get signature type. More...
 
 GetSignedVersionDocument (file_path)
 Get the PDF document in the signed version in which current signature was signed. More...
 
 GetSignTime ()
 Get time of signing. More...
 
 GetState ()
 Get current state. More...
 
 GetSubFilter ()
 Get sub filter. More...
 
 IsEmpty ()
 Check whether current object is empty or not. More...
 
 IsSigned ()
 Check whether current signature is signed or not. More...
 
 IsTimeStamp ()
 Check if current signature is a time stamp signature. More...
 
 SetAppearanceContent (appearance_content)
 Set customized appearance content (as low level drawing operation commands) for signed signature appearance. More...
 
 SetAppearanceFlags (appearance_flags)
 Set signature appearance flags. More...
 
 SetBitmap (bitmap)
 Set a bitmap for the signature appearance. More...
 
 SetCertChain (cert_chain)
 Set a certificate chain. More...
 
 SetCustomObject (key, pdf_object)
 Set custom PDF object for signature dictionary. More...
 
 SetDefaultContentsLength (default_length)
 Set the default length of signature contents which represents signature value (known as signed data). More...
 
 SetDocPermission (permission)
 Set document permission for current signature. More...
 
 SetFieldMDPActionFields (action, field_array)
 Set FieldMDP("MDP" means modification detection and prevention) action names array. More...
 
 SetFilter (filter)
 Set filter. More...
 
 SetImage (file_path, frame_index)
 Set an image for the signature appearance, with a specified frame index. More...
 
 SetImage (image, frame_index)
 Set an image for the signature appearance, with a specified frame index. More...
 
 SetKeyLabel (label_name, label_value)
 Set the string for specified key label. More...
 
 SetKeyValue (key, value)
 Set the string value for specified key name. More...
 
 SetSignTime (sign_time)
 Set time of signing. More...
 
 SetSubFilter (sub_filter)
 Set sub filter. More...
 
 StartSign (cert_file_stream, cert_password, digest_algorithm, save_path, client_data, pause)
 Start signing current signature if current signature is unsigned. More...
 
 StartSign (cert_path, cert_password, digest_algorithm, save_path, client_data, pause)
 Start signing current signature if current signature is unsigned. More...
 
 StartSign (cert_path, cert_password, digest_algorithm, stream_callback, client_data, pause)
 Start signing current signature if current signature is unsigned. More...
 
 StartVerify (client_data, pause)
 Start verifying the intergrity of current signature if current signature is signed. More...
 

Static Public Attributes

static e_PagingSealAPStateInvalid
 Verification state of a signature is invalid.
 
static e_PagingSealAPStateSigned
 Signed signature.
 
static e_PagingSealAPStateUnknown
 Enumeration for paging seal signature state to set appearance. More...
 
static e_PagingSealAPStateUnsigned
 Unsigned signature.
 
static e_PagingSealAPStateValid
 Verification state of a signature is valid.
 
- Static Public Attributes inherited from FSDK.Signature
static e_APFlagBitmap
 If set, show bitmap on signature appearance.
 
static e_APFlagDN
 If set, show distinguish name on signature appearance.
 
static e_APFlagFoxitEditorFlag
 If set, show Foxit Editor content on signature appearance.
 
static e_APFlagFoxitFlag
 Enumeration for signature appearance flags. More...
 
static e_APFlagLabel
 If set, show label on signature appearance.
 
static e_APFlagLocation
 If set, show location on signature appearance.
 
static e_APFlagProducer
 If set, show producer content on signature appearance.
 
static e_APFlagReason
 If set, show reason on signature appearance.
 
static e_APFlagSigner
 If set, show signer on signature appearance.
 
static e_APFlagSigningTime
 If set, show signing time on signature appearance.
 
static e_APFlagText
 If set, show text content on signature appearance.
 
static e_DigestSHA1
 Enumeration for signature digest algorithm. More...
 
static e_DigestSHA256
 Signature digest algorithm: sha256 algorithm.
 
static e_DigestSHA384
 Signature digest algorithm: sha384 algorithm.
 
static e_DigestSHA512
 Signature digest algorithm: sha512 algorithm.
 
static e_DocPermFillingFormAndSigning
 Permitted changes are filling in forms, instantiating page templates, and signing. Other changes will invalidate the signature.
 
static e_DocPermFillingFormSigningAndAnnotating
 Permitted changes are the same as for 2, as well as annotation creation, deletion, and modification. Other changes will invalidate the signature.
 
static e_DocPermNoChangesAllowed
 No changes to the PDF document (which is signed by the signture) are permitted. Any change to this kind of PDF document will invalidate the signature.
 
static e_DocPermUnrestricted
 Enumeration for signature document permission. More...
 
static e_FieldMDPActionAll
 All form fields' flags will be set read-only.
 
static e_FieldMDPActionExclude
 Flags of form fields (except specified form fields) will be set read-only. More...
 
static e_FieldMDPActionInclude
 Specified form fields' flags will be set read-only. More...
 
static e_FieldMDPActionNone
 Enumeration for signature FieldMDP("MDP" means modification detection and prevention) action type. More...
 
static e_KeyNameContactInfo
 Signature key name: contact information.
 
static e_KeyNameDN
 Signature key name: distinguish name.
 
static e_KeyNameLocation
 Signature key name: location.
 
static e_KeyNameProducer
 Signature key name: producer content.
 
static e_KeyNameReason
 Signature key name: reason.
 
static e_KeyNameSigner
 Enumeration for signature key name. More...
 
static e_KeyNameText
 Signature key name: text content.
 
static e_LabelNameDN
 Signature key name for distinguish name. More...
 
static e_LabelNameLocation
 Signature label name for location. More...
 
static e_LabelNameProducer
 Signature key name for producer name. More...
 
static e_LabelNameReason
 Signature label name for reason. More...
 
static e_LabelNameSigner
 Enumeration for signature label name. More...
 
static e_LabelNameSignTime
 Signature label name for sign time. More...
 
static e_PAdESLevelBB
 PAdES level: B-B.
 
static e_PAdESLevelBLT
 PAdES level: B-LT.
 
static e_PAdESLevelBLTA
 PAdES level: B-LTA.
 
static e_PAdESLevelBT
 PAdES level: B-T.
 
static e_PAdESLevelNone
 PAdES level: none.
 
static e_PAdESLevelNotPAdES
 Enumeration for PAdES level. More...
 
static e_SignatureTypeOrdinary
 Enumeration for signature type. More...
 
static e_SignatureTypePagingSeal
 Signature type: paging seal.
 
static e_SignatureTypeTimeStamp
 Signature type: time stamp.
 
static e_StateCertCannotGetVRI
 Cannot get verify relevant information.
 
static e_StateNoSignData
 Signature does not have any data for signing.It means that there is not "V" entry in the signature dictionary.
 
static e_StateSigned
 Signed signature.
 
static e_StateUnknown
 Enumeration for signature states. More...
 
static e_StateUnsigned
 Unsigned signature.
 
static e_StateVerifyChange
 The document has been changed within the scope of the signature. (This indicates that signature is invalid.)
 
static e_StateVerifyChangeIllegal
 The document has been changed outside of signature scope, and the changed invalidate the signature.
 
static e_StateVerifyChangeLegal
 The document has been changed outside of signature scope, but the changed is permitted.
 
static e_StateVerifyErrorByteRange
 Non expected byte range.
 
static e_StateVerifyErrorData
 Signature data is destroyed (that means the signature data cannot be parsed properly).
 
static e_StateVerifyIncredible
 Signature cannot be trusted (containing aggression).
 
static e_StateVerifyInvalid
 Verification state of a signature is invalid.
 
static e_StateVerifyIssueCurrent
 The verified issue is current issuer.
 
static e_StateVerifyIssueExpire
 Certificate for verifying issuer is expired.
 
static e_StateVerifyIssueRevoke
 Certificate for verifying issuer is revoked.
 
static e_StateVerifyIssueUncheck
 Not check the issuer.
 
static e_StateVerifyIssueUnknown
 Verification state of the issuer is unknown.
 
static e_StateVerifyIssueValid
 Verification state of the issuer is valid.
 
static e_StateVerifyNoChange
 The document has not been changed within the scope of the signature.
 
static e_StateVerifyTimestampDoc
 The signature is a time stamp signature.
 
static e_StateVerifyTimestampExpire
 Verification state of the time stamp is expired.
 
static e_StateVerifyTimestampInvalid
 Verification state of the time stamp is invalid.
 
static e_StateVerifyTimestampIssueUnknown
 Verification state of the time stamp issuer is unknown.
 
static e_StateVerifyTimestampIssueValid
 Verification state of the time stamp issuer is valid.
 
static e_StateVerifyTimestampNone
 No time stamp or not check time stamp.
 
static e_StateVerifyTimestampTimeBefore
 Verification state of the time stamp time is valid, since the times is before the expiration date.
 
static e_StateVerifyTimestampValid
 Verification state of the time stamp is valid.
 
static e_StateVerifyValid
 Verification state of a signature is valid.
 

Additional Inherited Members

- Public Attributes inherited from FSDK.Signature
 e_StateVerifyNoSupportWay
 Unsupported signature.
 

Detailed Description

This class represents a paging seal signature object for signing the signatures. It is a type of signature field, so class FSDK.PagingSealSignature is derived from class FSDK.Signature. A new paging seal signature object would be returned by function FSDK.PDFDoc.AddPagingSealSignature, instead of FSDK.PDFPage.AddSignature.
A paging seal signature contains a few signatures or a few paging seal annotation. To set the configuration of paging seal signature, please use the function FSDK.PagingSealSignature.SetPagingSealConfig.

Member Function Documentation

◆ GenerateAppearance()

FSDK.PagingSealSignature.GenerateAppearance ( )

Generate the appearance of paging seal signature.

This function should be called before signing and the paging seal config should be set already. If this function is not called, the page will not display the paging seal signatures.

Returns
true means success, while false means failure.

◆ SetAPStateBitmap()

FSDK.PagingSealSignature.SetAPStateBitmap ( ap_state  ,
bitmap   
)

Set a bitmap for the appearance of signature state.

If user wants the setting by this function has effect on paging seal signatures' appearance, please call function FSDK.PagingSealSignature.GenerateAppearence after this function.

Parameters
[in]ap_stateThe state of signature.
[in]bitmapA bitmap to be set to the appearance.
Returns
None.

◆ SetPagingSealConfig()

FSDK.PagingSealSignature.SetPagingSealConfig ( paging_seal_config  )

Set the config of paging seal signature.

Parameters
[in]paging_seal_configA paging seal configuration to be set.
Returns
None.

Member Data Documentation

◆ e_PagingSealAPStateUnknown

FSDK.PagingSealSignature.e_PagingSealAPStateUnknown
static

Enumeration for paging seal signature state to set appearance.

Values of this enumeration should be used alone.

Unknown signature.