PSPDFSignatureFormElement

Objective-C


@interface PSPDFSignatureFormElement : PSPDFFormElement

Swift

class SignatureFormElement : FormElement

Represents a Signature Form Element A digital signature (PDF 1.3) may be used to verify the integrity of the document’s contents using verification information related to a signer.

See

https://pspdfkit.com/guides/ios/features/digital-signatures/

  • Returns YES if the signature field is digitally signed.

    Note

    This does not mean that the signature is valid.

    Declaration

    Objective-C

    @property (readonly) BOOL isSigned;

    Swift

    var isSigned: Bool { get }

  • The signature dictionary contains signature information.

    Declaration

    Objective-C

    @property (readonly, nullable) PSPDFSignatureInfo *signatureInfo;

    Swift

    var signatureInfo: PSPDFSignatureInfo? { get }

  • Searches the document for a signature annotation that overlaps the form element.

    This can only be an ink signature, or a stamp signature. Stamp annotations need to have isSignature set to be considered.

    Declaration

    Objective-C

    @property (readonly, nullable) PSPDFAnnotation *overlappingSignatureAnnotation;

    Swift

    var overlappingSignatureAnnotation: Annotation? { get }

  • Returns the biometric properties of this signature with parameters like pressure, time information, or input device or nil if there’s no such information.

    Note

    As the information is encrypted inside the document, it requires the corresponding private key to access it.

    Declaration

    Objective-C

    - (nullable PSPDFSignatureBiometricProperties *)signatureBiometricProperties:
    (nonnull PSPDFPrivateKey *)privateKey;

    Swift

    func signatureBiometricProperties(_ privateKey: PSPDFPrivateKey) -> PSPDFSignatureBiometricProperties?

  • This will remove the digital signature of the signature form element.

    Only works if

    • the form element is digitally signed (isSigned needs to be set.)
    • the document of the signature form element is set

    • the document can save and embed annotations

    Note

    This will save the document.

    @returns Whether removing the digital signature was successful.

    Declaration

    Objective-C

    - (BOOL)removeSignatureWithError:(NSError *_Nullable *_Nullable)error;

    Swift

    func removeSignature() throws

    Parameters

    error

    Will be set if this method returns false and removing the signature failed.