SignatureLine (Aspose.Words for Java API Reference)

java.lang.Object
- com.aspose.words.SignatureLine

```
public class SignatureLine
extends java.lang.Object
```
Provides access to signature line properties.
To learn more, visit the Work with Digital Signatures documentation article.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`getAllowComments()` Gets a value indicating that the signer can add comments in the Sign dialog.
`boolean`	`getDefaultInstructions()` Gets a value indicating that default instructions is shown in the Sign dialog.
`java.lang.String`	`getEmail()` Gets suggested signer's e-mail address.
`java.util.UUID`	`getId()` Gets identifier for this signature line.
`java.lang.String`	`getInstructions()` Gets instructions to the signer that are displayed on signing the signature line.
`java.util.UUID`	`getProviderId()` Gets signature provider identifier for this signature line.
`boolean`	`getShowDate()` Gets a value indicating that sign date is shown in the signature line.
`java.lang.String`	`getSigner()` Gets suggested signer of the signature line.
`java.lang.String`	`getSignerTitle()` Gets suggested signer's title (for example, Manager).
`boolean`	`isSigned()` Indicates that signature line is signed by digital signature.
`boolean`	`isValid()` Indicates that signature line is signed by digital signature and this digital signature is valid.
`void`	`setAllowComments(boolean value)` Sets a value indicating that the signer can add comments in the Sign dialog.
`void`	`setDefaultInstructions(boolean value)` Sets a value indicating that default instructions is shown in the Sign dialog.
`void`	`setEmail(java.lang.String value)` Sets suggested signer's e-mail address.
`void`	`setId(java.util.UUID value)` Sets identifier for this signature line.
`void`	`setInstructions(java.lang.String value)` Sets instructions to the signer that are displayed on signing the signature line.
`void`	`setProviderId(java.util.UUID value)` Sets signature provider identifier for this signature line.
`void`	`setShowDate(boolean value)` Sets a value indicating that sign date is shown in the signature line.
`void`	`setSigner(java.lang.String value)` Sets suggested signer of the signature line.
`void`	`setSignerTitle(java.lang.String value)` Sets suggested signer's title (for example, Manager).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getSigner
```
public java.lang.String getSigner()
```
    Gets suggested signer of the signature line. Default value for this property is empty string.
    
    Returns:
    
    Suggested signer of the signature line.
  - setSigner
```
public void setSigner(java.lang.String value)
               throws java.lang.Exception
```
    Sets suggested signer of the signature line. Default value for this property is empty string.
    
    Parameters:
    
    value - Suggested signer of the signature line.
    
    Throws:
    
    java.lang.Exception
  - getSignerTitle
```
public java.lang.String getSignerTitle()
```
    Gets suggested signer's title (for example, Manager). Default value for this property is empty string.
    
    Returns:
    
    Suggested signer's title (for example, Manager).
  - setSignerTitle
```
public void setSignerTitle(java.lang.String value)
                    throws java.lang.Exception
```
    Sets suggested signer's title (for example, Manager). Default value for this property is empty string.
    
    Parameters:
    
    value - Suggested signer's title (for example, Manager).
    
    Throws:
    
    java.lang.Exception
  - getEmail
```
public java.lang.String getEmail()
```
    Gets suggested signer's e-mail address. Default value for this property is empty string.
    
    Returns:
    
    Suggested signer's e-mail address.
  - setEmail
```
public void setEmail(java.lang.String value)
```
    Sets suggested signer's e-mail address. Default value for this property is empty string.
    
    Parameters:
    
    value - Suggested signer's e-mail address.
  - getDefaultInstructions
```
public boolean getDefaultInstructions()
```
    Gets a value indicating that default instructions is shown in the Sign dialog. Default value for this property is true.
    
    Returns:
    
    A value indicating that default instructions is shown in the Sign dialog.
  - setDefaultInstructions
```
public void setDefaultInstructions(boolean value)
```
    Sets a value indicating that default instructions is shown in the Sign dialog. Default value for this property is true.
    
    Parameters:
    
    value - A value indicating that default instructions is shown in the Sign dialog.
  - getInstructions
```
public java.lang.String getInstructions()
```
    Gets instructions to the signer that are displayed on signing the signature line. This property is ignored if getDefaultInstructions() / setDefaultInstructions(boolean) is set. Default value for this property is empty string.
    
    Returns:
    
    Instructions to the signer that are displayed on signing the signature line.
  - setInstructions
```
public void setInstructions(java.lang.String value)
```
    Sets instructions to the signer that are displayed on signing the signature line. This property is ignored if getDefaultInstructions() / setDefaultInstructions(boolean) is set. Default value for this property is empty string.
    
    Parameters:
    
    value - Instructions to the signer that are displayed on signing the signature line.
  - getAllowComments
```
public boolean getAllowComments()
```
    Gets a value indicating that the signer can add comments in the Sign dialog. Default value for this property is false.
    
    Returns:
    
    A value indicating that the signer can add comments in the Sign dialog.
  - setAllowComments
```
public void setAllowComments(boolean value)
```
    Sets a value indicating that the signer can add comments in the Sign dialog. Default value for this property is false.
    
    Parameters:
    
    value - A value indicating that the signer can add comments in the Sign dialog.
  - getShowDate
```
public boolean getShowDate()
```
    Gets a value indicating that sign date is shown in the signature line. Default value for this property is true.
    
    Returns:
    
    A value indicating that sign date is shown in the signature line.
  - setShowDate
```
public void setShowDate(boolean value)
```
    Sets a value indicating that sign date is shown in the signature line. Default value for this property is true.
    
    Parameters:
    
    value - A value indicating that sign date is shown in the signature line.
  - getId
```
public java.util.UUID getId()
```
    Gets identifier for this signature line.
    This identifier can be associated with a digital signature, when signing document using DigitalSignatureUtil. This value must be unique and by default it is randomly generated new Guid.
    
    Returns:
    
    Identifier for this signature line.
  - setId
```
public void setId(java.util.UUID value)
```
    Sets identifier for this signature line.
    This identifier can be associated with a digital signature, when signing document using DigitalSignatureUtil. This value must be unique and by default it is randomly generated new Guid.
    
    Parameters:
    
    value - Identifier for this signature line.
  - getProviderId
```
public java.util.UUID getProviderId()
```
    Gets signature provider identifier for this signature line. Default value is "{00000000-0000-0000-0000-000000000000}".
    The cryptographic service provider (CSP) is an independent software module that actually performs cryptography algorithms for authentication, encoding, and encryption. MS Office reserves the value of {00000000-0000-0000-0000-000000000000} for its default signature provider.
    
    The GUID of the additionally installed provider should be obtained from the documentation shipped with the provider.
    
    In addition, all the installed cryptographic providers are enumerated in windows registry. It can be found in the following path: HKLM\SOFTWARE\Microsoft\Cryptography\Defaults\Provider. There is a key name "CP Service UUID" which corresponds to a GUID of signature provider.
    
    Returns:
    
    Signature provider identifier for this signature line.
  - setProviderId
```
public void setProviderId(java.util.UUID value)
```
    Sets signature provider identifier for this signature line. Default value is "{00000000-0000-0000-0000-000000000000}".
    The cryptographic service provider (CSP) is an independent software module that actually performs cryptography algorithms for authentication, encoding, and encryption. MS Office reserves the value of {00000000-0000-0000-0000-000000000000} for its default signature provider.
    
    The GUID of the additionally installed provider should be obtained from the documentation shipped with the provider.
    
    In addition, all the installed cryptographic providers are enumerated in windows registry. It can be found in the following path: HKLM\SOFTWARE\Microsoft\Cryptography\Defaults\Provider. There is a key name "CP Service UUID" which corresponds to a GUID of signature provider.
    
    Parameters:
    
    value - Signature provider identifier for this signature line.
  - isSigned
```
public boolean isSigned()
```
    Indicates that signature line is signed by digital signature.
    
    Returns:
    
    The corresponding boolean value.
  - isValid
```
public boolean isValid()
```
    Indicates that signature line is signed by digital signature and this digital signature is valid.
    
    Returns:
    
    The corresponding boolean value.

Class SignatureLine

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getSigner

setSigner

getSignerTitle

setSignerTitle

getEmail

setEmail

getDefaultInstructions

setDefaultInstructions

getInstructions

setInstructions

getAllowComments

setAllowComments

getShowDate

setShowDate

getId

setId

getProviderId

setProviderId

isSigned

isValid