Foxit PDF RDK

Public Member Functions | Static Public Attributes | List of all members
PagingSealSignature Class Reference
Inheritance diagram for PagingSealSignature:

## 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 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 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...
< Progressive > | 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...
Public Member Functions inherited from Field
| constructor (document, field_dict)
| Constructor, from field dictionary. More...
| constructor (field)
| Constructor, with another form field object. More...
| GetAlignment ()
| Get the alignment value. More...
| GetAlternateName ()
| Get alternate name. More...
| GetControl (index)
| Get a form control by index. More...
| GetControl (page, index)
| Get a form control by index, in a specified PDF page. More...
| GetControlCount ()
| Get count of form controls. More...
| GetControlCount (page)
| Get count of form controls in a specified PDF page. More...
| GetDefaultAppearance ()
| Get the default appearance data. More...
| GetDefaultValue ()
| Get default value. More...
| GetDefaultValueObj ()
| Get the PDF object of field's default value. More...
| GetDict ()
| Get the PDF dictionary of current object. More...
| GetFlags ()
| Get field flags. More...
| GetInheritedAttribute (attribute_name)
| Get the PDF object for specified attribute which may be inherited from the ancestor node in the field tree. More...
| GetMappingName ()
| Get mapping name. More...
| GetMaxLength ()
| Get maximum length of the field's text, in characters. More...
| GetName ()
| Get field name. More...
| GetOptions ()
| Get options of list box or combo box. More...
| GetTopVisibleIndex ()
| Get top index of option for scrollable list boxes. More...
| GetType ()
| Get field type. More...
| GetValue ()
| Get value. More...
| GetValueObj ()
| Get the PDF object of field's value. More...
| IsEmpty ()
| Check whether current object is empty or not. More...
| Reset ()
| Reset data in current field to its default value. (Not support signature field) More...
| SetAlignment (alignment)
| Set alignment property of a form, as a document-wide default value. (Not support signature field) More...
| SetAlternateName (alternate_name)
| Set alternate name. (Not support signature field) More...
| SetDefaultAppearance (default_ap)
| Set default appearance data. More...
| SetDefaultValue (value)
| Set default value. More...
| SetFlags (flags)
| Set field flags. More...
| SetMappingName (name)
| Set mapping name. (Not support signature field) More...
| SetMaxLength (max_length)
| Set maximum length of the field's text, in characters. More...
| SetOptions (option_array)
| Set options of list box or combo box. More...
| SetTopVisibleIndex (index)
| Set top index for scrollable list boxes. More...
| SetValue (value)
| Set value. More...
Public Member Functions inherited from NativeObjectWrapper
| constructor (r)
| GetPointerAsNumber ()

## 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 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.
Static Public Attributes inherited from Field
static | e_FlagButtonNoToggleToOff
| (Only useful for radio button) If set, exactly one radio button must be selected at all times; clicking the currently selected button has no effect. If clear, clicking the selected button deselects it, leaving no button selected.
static | e_FlagButtonRadiosInUnison
| (Only useful for radio button) If set, a group of radio buttons within a radio button field that use the same value for the on state will turn on and off in unison; that is if one is checked, they are all checked. If clear, the buttons are mutually exclusive.
static | e_FlagChoiceCommitOnSelChange
| (Only useful for choice field) If set, the new value is committed as soon as a selection is made with the pointing device; if clear, the new value is not committed until the user exits the field.
static | e_FlagChoiceMultiSelect
| (Only useful for list box) If set, more than one items may be selected simultaneously; if clear, no more than one item at a time may be selected.
static | e_FlagChoiceSort
| (Only useful for choice field) If set, the field's option items should be sorted alphabetically.
static | e_FlagComboEdit
| (Only useful for combo box) If set, the combo box includes an editable text control with a drop-down list, if clear, it includes only a drop-down list.
static | e_FlagNoExport
| if set, the field must not be exported by a submit-form action.
static | e_FlagReadOnly
| Enumeration for form field flags. More...
static | e_FlagRequired
| If set, the field must have a value at the time it is exported by a submit-form action.
static | e_FlagTextComb
| (Only useful for text field) If set, use combs. More...
static | e_FlagTextDoNotScroll
| (Only useful for text field) If set, the field does not scroll (horizontally for single-line fields, vertically for multiple-line fields) to accommodate more text than fits within its annotation rectangle. Once the field is full, no further text is accepted.
static | e_FlagTextFileSelect
| (Only useful for text field) If set, the text entered in the field represents the pathname of a file whose contents are to be submitted as the value of the field.
static | e_FlagTextMultiline
| (Only useful for text field) If set, the text field can contain multiple lines of text; if clear, the field's text is restricted to a single line.
static | e_FlagTextNoSpellCheck
| (Only useful for text field) If set, text entered in the field is not spell-checked.
static | e_FlagTextPassword
| (Only useful for text field) If set, the field is intended for entering a secure password that should not be echoed visibly to the screen. Characters typed from the keyboard should instead be echoed in some unreadable form, such as asterisks or bullet characters. More...
static | e_FlagTextRichText
| (Only useful for text field) If set, the value of this field should be represented as a rich text string.
static | e_TypeCheckBox
| Form field type: check box.
static | e_TypeComboBox
| Form field type: combo box.
static | e_TypeListBox
| Form field type: list box.
static | e_TypePushButton
| Form field type: push button.
static | e_TypeRadioButton
| Form field type: radio button.
static | e_TypeSignature
| Form field type: signature field.
static | e_TypeTextField
| Form field type: text field.
static | e_TypeUnknown
| Enumeration for form field type. More...

## Additional Inherited Members
Public Attributes inherited from 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 PagingSealSignature is derived from class Signature. A new paging seal signature object would be returned by function PDFDoc.AddPagingSealSignature, instead of 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 PagingSealSignature.SetPagingSealConfig.

Examples
  /Users/ec2-user/gitlab-runner/builds/E-xKdhDo/0/foxit/sdk/mobile/gsdk-doc-auto-build/harmony_nodejs/input/Index.js.

## Member Function Documentation

## ◆ GenerateAppearance()

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()

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 PagingSealSignature.GenerateAppearence after this function.

Parameters

  [in] | ap_state | The state of signature.
  [in] | bitmap | A bitmap to be set to the appearance.

Returns
  None.

## ◆ SetPagingSealConfig()

PagingSealSignature.SetPagingSealConfig | ( | paging_seal_config |  | ) |

Set the config of paging seal signature.

Parameters

  [in] | paging_seal_config | A paging seal configuration to be set.

Returns
  None.

## Member Data Documentation

## ◆ e_PagingSealAPStateUnknown

PagingSealSignature.e_PagingSealAPStateUnknown
| static

Enumeration for paging seal signature state to set appearance.

Values of this enumeration should be used alone.

Unknown signature.