[]
DEMOS DOCS API PRICING
FREE TRIAL
(Showing Draft Content)

ISignatureSetup

Interface ISignatureSetup

public interface ISignatureSetup
Represents the information used to set up a signature packet.

This interface provides the signer metadata and signing options for a signature line in a workbook, such as the suggested signer, signer email address, signing instructions, comment availability, and whether the sign date is displayed. It is typically obtained from a ISignature created for a worksheet signature line.


 ISignature signature = workbook.getSignatures().addSignatureLine(worksheet, 100.0, 50.0);
 ISignatureSetup setup = signature.getSetup();
 setup.setSuggestedSigner("John Williams");
 setup.setSuggestedSignerEmail("john.williams@example.com");
 setup.setSigningInstructions("Please review and sign this worksheet.");

  • Method Details

    • getAllowComments

      boolean getAllowComments()
      Gets a Boolean value specifying whether the signer can enter comments in the Sign dialog box. Read/write.

      Use this property to determine whether comment entry is enabled for the signature line when the document is signed.

      
 ISignature signature = workbook.getSignatures().addSignatureLine(worksheet, 100.0, 50.0, 192.0, 100.5);
 ISignatureSetup setup = signature.getSetup();
 setup.setAllowComments(true);
 boolean allowComments = setup.getAllowComments();
      Returns:
      true if the signer can enter comments in the Sign dialog box; otherwise, false.

    • setAllowComments

      void setAllowComments(boolean value)
      Sets a Boolean value specifying whether the signer can enter comments in the Sign dialog box. Read/write.

      Use this property to set whether comment entry is enabled for the signature line when the document is signed.

      
 ISignature signature = workbook.getSignatures().addSignatureLine(worksheet, 100.0, 50.0, 192.0, 100.5);
 ISignatureSetup setup = signature.getSetup();
 setup.setAllowComments(true);
      Parameters:
      value - true if the signer can enter comments in the Sign dialog box; otherwise, false.

    • getId

      UUID getId()
      Gets the ID of the signature for a document.

      This identifier belongs to the signature associated with this setup information.

      
 ISignature signature = workbook.getSignatures().addSignatureLine(worksheet, 100, 50);
 ISignatureSetup setup = signature.getSetup();
 UUID id = setup.getId();
      Returns:
      The UUID that identifies the signature for the document.

    • getShowSignDate

      boolean getShowSignDate()
      Gets a Boolean value indicating whether the date the document was signed should be displayed. Read/write.

      Use this property to determine whether the signature line is configured to show the signing date after the document is signed.

      
 ISignature signature = workbook.getSignatures().addSignatureLine(worksheet, 100.0, 50.0, 192.0, 100.5);
 ISignatureSetup setup = signature.getSetup();
 setup.setShowSignDate(true);
 boolean showSignDate = setup.getShowSignDate();
      Returns:
      true if the signature line is configured to display the date the document was signed; otherwise, false.

    • setShowSignDate

      void setShowSignDate(boolean value)
      Sets a Boolean value indicating whether the date the document was signed should be displayed. Read/write.

      Use this property to set whether the signature line is configured to show the signing date after the document is signed.

      
 ISignature signature = workbook.getSignatures().addSignatureLine(worksheet, 100.0, 50.0, 192.0, 100.5);
 ISignatureSetup setup = signature.getSetup();
 setup.setShowSignDate(true);
      Parameters:
      value - true if the signature line is configured to display the date the document was signed; otherwise, false.

    • getSigningInstructions

      String getSigningInstructions()
      Gets the instructions for signing the document. Read/write.

      Use this property to retrieve the signing instructions configured for a signature line.

      
 ISignature signature = workbook.getSignatures().addSignatureLine(worksheet, 100.0, 50.0, 192.0, 100.5);
 ISignatureSetup setup = signature.getSetup();
 setup.setSigningInstructions("Please review the agreement before signing.");
 String instructions = setup.getSigningInstructions();
      Returns:
      The instructions for signing the document.

    • setSigningInstructions

      void setSigningInstructions(String value)
      Sets the instructions for signing the document. Read/write.

      Use this property to set the signing instructions configured for a signature line.

      
 ISignature signature = workbook.getSignatures().addSignatureLine(worksheet, 100.0, 50.0, 192.0, 100.5);
 ISignatureSetup setup = signature.getSetup();
 setup.setSigningInstructions("Please review the agreement before signing.");
      Parameters:
      value - The instructions for signing the document.

    • getSuggestedSigner

      String getSuggestedSigner()
      Gets the name of the principal signer of the document. 
      
 ISignature signature = workbook.getSignatures().addSignatureLine(worksheet, 100.0, 50.0, 192.0, 100.5);
 ISignatureSetup setup = signature.getSetup();
 setup.setSuggestedSigner("John Williams");
 String suggestedSigner = setup.getSuggestedSigner();
      Returns:
      The name of the principal signer of the document.

    • setSuggestedSigner

      void setSuggestedSigner(String value)
      Sets the name of the principal signer of the document. 
      
 ISignature signature = workbook.getSignatures().addSignatureLine(worksheet, 100.0, 50.0, 192.0, 100.5);
 ISignatureSetup setup = signature.getSetup();
 setup.setSuggestedSigner("John Williams");
      Parameters:
      value - The name of the principal signer of the document.

    • getSuggestedSignerEmail

      String getSuggestedSignerEmail()
      Gets the email address of the signer of the document. Read/write.

      Returns the email address configured for the suggested signer in the signature setup. Use setSuggestedSignerEmail(String) to define the value returned by this method.

      
 ISignature signature = workbook.getSignatures().addSignatureLine(worksheet, 100.0, 50.0, 192.0, 100.5);
 ISignatureSetup setup = signature.getSetup();
 setup.setSuggestedSignerEmail("alex.wilson@example.com");
 String email = setup.getSuggestedSignerEmail();
      Returns:
      The email address of the signer of the document.

    • setSuggestedSignerEmail

      void setSuggestedSignerEmail(String value)
      Sets the email address of the signer of the document. Read/write. 
      
 ISignature signature = workbook.getSignatures().addSignatureLine(worksheet, 100.0, 50.0, 192.0, 100.5);
 ISignatureSetup setup = signature.getSetup();
 setup.setSuggestedSignerEmail("alex.wilson@example.com");
      Parameters:
      value - The email address of the signer of the document.

    • getSuggestedSignerLine2

      String getSuggestedSignerLine2()
      Gets the second line of suggested signer information (for example, title).

      This value is used as additional signer information for a signature line, such as the signer's title or role.

      
 ISignature signature = workbook.getSignatures().addSignatureLine(worksheet, 100.0, 50.0, 192.0, 100.5);
 ISignatureSetup setup = signature.getSetup();
 setup.setSuggestedSignerLine2("Finance Manager");
 String signerLine2 = setup.getSuggestedSignerLine2();
      Returns:
      The second line of suggested signer information, such as the signer's title or role.

    • setSuggestedSignerLine2

      void setSuggestedSignerLine2(String value)
      Sets the second line of suggested signer information (for example, title).

      This value is used as additional signer information for a signature line, such as the signer's title or role.

      
 ISignature signature = workbook.getSignatures().addSignatureLine(worksheet, 100.0, 50.0, 192.0, 100.5);
 ISignatureSetup setup = signature.getSetup();
 setup.setSuggestedSignerLine2("Finance Manager");
      Parameters:
      value - The second line of suggested signer information, such as the signer's title or role.