ISignatureSetup

Interface ISignatureSetup

---

public interface ISignatureSetup

表示用于设置签名数据包的信息。

此接口为工作簿中的签名线提供签署者元数据和签署选项，例如建议签署者、签署者电子邮件地址、签署说明、是否允许注释以及是否显示签署日期。它通常从为工作表签名线创建的 ISignature 获取。

 ISignature signature = workbook.getSignatures().addSignatureLine(worksheet, 100.0, 50.0);
 ISignatureSetup setup = signature.getSetup();
 setup.setSuggestedSigner("John Williams");
 setup.setSuggestedSignerEmail("[e-mail]");
 setup.setSigningInstructions("Please review and sign this worksheet.");
 

• Method Summary

  All MethodsInstance MethodsAbstract Methods

  Modifier and Type

  Method

  Description

  boolean

  getAllowComments()

  获取一个布尔值，指定签署者是否可以在“签名”对话框中输入注释。可读/可写。

  UUID

  getId()

  获取文档签名的 ID。

  boolean

  getShowSignDate()

  获取一个布尔值，指示是否应显示文档签署日期。可读/可写。

  String

  getSigningInstructions()

  获取用于签署文档的说明。可读/可写。

  String

  getSuggestedSigner()

  获取文档主要签署者的姓名。

  String

  getSuggestedSignerEmail()

  获取文档签署者的电子邮件地址。可读/可写。

  String

  getSuggestedSignerLine2()

  获取建议签署者信息的第二行（例如，职务）。

  void

  setAllowComments(boolean value)

  设置一个布尔值，指定签署者是否可以在“签名”对话框中输入注释。可读/可写。

  void

  setShowSignDate(boolean value)

  设置一个布尔值，指示是否应显示文档签署日期。可读/可写。

  void

  setSigningInstructions(String value)

  设置用于签署文档的说明。可读/可写。

  void

  setSuggestedSigner(String value)

  设置文档主要签署者的姓名。

  void

  setSuggestedSignerEmail(String value)

  设置文档签署者的电子邮件地址。可读/可写。

  void

  setSuggestedSignerLine2(String value)

  设置建议签署者信息的第二行（例如，职务）。

• Method Details

  • getAllowComments

    boolean getAllowComments()

    获取一个布尔值，指定签署者是否可以在“签名”对话框中输入注释。可读/可写。

    使用此属性可以确定在文档签署时，是否为签名线启用注释输入。

    
     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；否则为 false。

  • setAllowComments

    void setAllowComments(boolean value)

    设置一个布尔值，指定签署者是否可以在“签名”对话框中输入注释。可读/可写。

    使用此属性可设置在文档签署时是否为签名线启用注释输入。

    
     ISignature signature = workbook.getSignatures().addSignatureLine(worksheet, 100.0, 50.0, 192.0, 100.5);
     ISignatureSetup setup = signature.getSetup();
     setup.setAllowComments(true);
     

    Parameters:

    value - 如果签署者可以在“签名”对话框中输入注释，则为 true；否则为 false。

  • getId

    UUID getId()

    获取文档签名的 ID。

    此标识符属于与此设置信息关联的签名。

    
     ISignature signature = workbook.getSignatures().addSignatureLine(worksheet, 100, 50);
     ISignatureSetup setup = signature.getSetup();
     UUID id = setup.getId();
     

    Returns:

    标识文档签名的 UUID。

  • getShowSignDate

    boolean getShowSignDate()

    获取一个布尔值，指示是否应显示文档签署日期。可读/可写。

    使用此属性可以确定签名线是否配置为在文档签署后显示签署日期。

    
     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；否则为 false。

  • setShowSignDate

    void setShowSignDate(boolean value)

    设置一个布尔值，指示是否应显示文档签署日期。可读/可写。

    使用此属性可设置签名线是否配置为在文档签署后显示签署日期。

    
     ISignature signature = workbook.getSignatures().addSignatureLine(worksheet, 100.0, 50.0, 192.0, 100.5);
     ISignatureSetup setup = signature.getSetup();
     setup.setShowSignDate(true);
     

    Parameters:

    value - 如果签名线配置为显示文档签署日期，则为 true；否则为 false。

  • getSigningInstructions

    String getSigningInstructions()

    获取用于签署文档的说明。可读/可写。

    使用此属性可以检索为签名线配置的签署说明。

    
     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:

    用于签署文档的说明。

  • setSigningInstructions

    void setSigningInstructions(String value)

    设置用于签署文档的说明。可读/可写。

    使用此属性可设置为签名线配置的签署说明。

    
     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 - 用于签署文档的说明。

  • getSuggestedSigner

    String getSuggestedSigner()

    获取文档主要签署者的姓名。

    
     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:

    文档主要签署者的姓名。

  • setSuggestedSigner

    void setSuggestedSigner(String value)

    设置文档主要签署者的姓名。

    
     ISignature signature = workbook.getSignatures().addSignatureLine(worksheet, 100.0, 50.0, 192.0, 100.5);
     ISignatureSetup setup = signature.getSetup();
     setup.setSuggestedSigner("John Williams");
     

    Parameters:

    value - 文档主要签署者的姓名。

  • getSuggestedSignerEmail

    String getSuggestedSignerEmail()

    获取文档签署者的电子邮件地址。可读/可写。

    返回在签名设置中为建议签署者配置的电子邮件地址。使用 setSuggestedSignerEmail(String) 可以定义此方法返回的值。

    
     ISignature signature = workbook.getSignatures().addSignatureLine(worksheet, 100.0, 50.0, 192.0, 100.5);
     ISignatureSetup setup = signature.getSetup();
     setup.setSuggestedSignerEmail("[e-mail]");
     String email = setup.getSuggestedSignerEmail();
     

    Returns:

    文档签署者的电子邮件地址。

  • setSuggestedSignerEmail

    void setSuggestedSignerEmail(String value)

    设置文档签署者的电子邮件地址。可读/可写。

    
     ISignature signature = workbook.getSignatures().addSignatureLine(worksheet, 100.0, 50.0, 192.0, 100.5);
     ISignatureSetup setup = signature.getSetup();
     setup.setSuggestedSignerEmail("[e-mail]");
     

    Parameters:

    value - 文档签署者的电子邮件地址。

  • getSuggestedSignerLine2

    String getSuggestedSignerLine2()

    获取建议签署者信息的第二行（例如，职务）。

    此值用作签名线的其他签署者信息，例如签署者的职务或角色。

    
     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:

    建议签署者信息的第二行，例如签署者的职务或角色。

  • setSuggestedSignerLine2

    void setSuggestedSignerLine2(String value)

    设置建议签署者信息的第二行（例如，职务）。

    此值用作签名线的其他签署者信息，例如签署者的职务或角色。

    
     ISignature signature = workbook.getSignatures().addSignatureLine(worksheet, 100.0, 50.0, 192.0, 100.5);
     ISignatureSetup setup = signature.getSetup();
     setup.setSuggestedSignerLine2("Finance Manager");
     

    Parameters:

    value - 建议签署者信息的第二行，例如签署者的职务或角色。