Package com.grapecity.documents.excel

Interface ISignature

public interface ISignature
Corresponds to a digital signature that is attached to a document.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    countersign(KeyStore certificate, String certificatePassword)
    Countersign the signature line, if the signature has been signed.
    void
    delete()
    Deletes the signature.
    boolean
    getCanSetup()
    Gets a Boolean value indicating whether the user can set properties of the Signature object.
    IReadOnlySignatureDetails
    getDetails()
    Gets information about a signature.
    boolean
    getIsSignatureLine()
    Gets a value indicating whether this is a signature line.
    boolean
    getIsSigned()
    Gets a Boolean value indicating whether the document was signed successfully.
    boolean
    getIsValid()
    Determines if the digital signature that corresponds to the Signature object is a valid signature.
    ISignatureSet
    getParent()
    Returns the Parent object for the specified object.
    ISignatureSetup
    getSetup()
    Gets a ISignatureSetup object that provides access to variousproperties of a signature packet.
    IShape
    getSignatureLineShape()
    Gets the Shape object associated with a Signature object that is a signature line.
    Calendar
    getSignDate()
    Returns an Object representing the date and time that the digital certificate corresponding to the Signature object was attached to the document.
    void
    sign(KeyStore certificate, String certificatePassword, SignatureDetails details)
    Creates a signature packet for non-visible signature line.
    void
    sign(KeyStore certificate, String certificatePassword, InputStream signatureImage, SignatureDetails details)
    Creates a signature packet for visible signature line.
    void
    sign(KeyStore certificate, String certificatePassword, String signatureText, SignatureDetails details)
    Creates a signature packet for visible signature line.

  • Method Details

    • getCanSetup

      boolean getCanSetup()
      Gets a Boolean value indicating whether the user can set properties of the Signature object. Read-only.

    • getDetails

      IReadOnlySignatureDetails getDetails()
      Gets information about a signature. Read-only.

    • getIsSignatureLine

      boolean getIsSignatureLine()
      Gets a value indicating whether this is a signature line. Read-only.

    • getIsSigned

      boolean getIsSigned()
      Gets a Boolean value indicating whether the document was signed successfully. Read-only.

    • getIsValid

      boolean getIsValid()
      Determines if the digital signature that corresponds to the Signature object is a valid signature.

    • getParent

      ISignatureSet getParent()
      Returns the Parent object for the specified object.

    • getSetup

      ISignatureSetup getSetup()
      Gets a ISignatureSetup object that provides access to variousproperties of a signature packet. Read-only.

    • getSignatureLineShape

      IShape getSignatureLineShape()
      Gets the Shape object associated with a Signature object that is a signature line. Read-only.

    • getSignDate

      Calendar getSignDate()
      Returns an Object representing the date and time that the digital certificate corresponding to the Signature object was attached to the document.

    • delete

      void delete()
      Deletes the signature.

    • sign

      void sign(KeyStore certificate, String certificatePassword, InputStream signatureImage, SignatureDetails details)
      Creates a signature packet for visible signature line.
      Parameters:
      certificate - The certificate that will be used to sign the workbook.
      details - The signature detail of the signature.
      signatureImage - The signature image of the signature line.
      Throws:
      IllegalStateException - Attempted to sign a non-visiblesignature line

    • sign

      void sign(KeyStore certificate, String certificatePassword, String signatureText, SignatureDetails details)
      Creates a signature packet for visible signature line.
      Parameters:
      certificate - The certificate that will be used to sign the workbook.
      details - The signature detail of the signature.
      signatureText - The signature text of the signature line.
      Throws:
      IllegalStateException - Attempted to sign a non-visiblesignature line

    • sign

      void sign(KeyStore certificate, String certificatePassword, SignatureDetails details)
      Creates a signature packet for non-visible signature line.
      Parameters:
      certificate - The certificate that will be used to sign the workbook.
      details - The signature detail of the signature.
      Throws:
      IllegalStateException - Attempted to sign a visible signatureline

    • countersign

      void countersign(KeyStore certificate, String certificatePassword)
      Countersign the signature line, if the signature has been signed.
      Parameters:
      certificate - The certificate that will be used to countersign theworkbook.
      Throws:
      IllegalStateException - The signature was not signed.