com.aspose.cells

Class SignatureLine

java.lang.Object

com.aspose.cells.SignatureLine

public class SignatureLine
extends java.lang.Object

Represent the signature line.

Example

 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
         Worksheet worksheet = workbook.getWorksheets().get(0);
 
         // Create signature line object
         SignatureLine s = new SignatureLine();
         s.setSigner("Simon");
         s.setTitle("Development");
         s.setEmail("simon@aspose.com");
         s.setInstructions("Sign to confirm the excel content.");
 
         // Adds a Signature Line to the worksheet.
         Picture signatureLine = worksheet.getShapes().addSignatureLine(0, 0, s);
 
         //do your business
 
         //Save the excel file.
         workbook.save("result.xlsx");
 

Constructor Summary

Constructors

Constructor and Description
SignatureLine()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getAllowComments() Indicates whether comments could be attached.
java.lang.String	getEmail() Gets the email of singer.
java.util.UUID	getId() Gets identifier for this signature line.
java.lang.String	getInstructions() Gets the text shown to user at signing time.
java.util.UUID	getProviderId() Gets the id of signature provider.
boolean	getShowSignedDate() Indicates whether show signed date.
int	getSignatureLineType() Gets the signature type.
java.lang.String	getSigner() Gets the signer.
java.lang.String	getTitle() Gets the title of singer.
boolean	isLine() Indicates whether it is a signature line.
void	setAllowComments(boolean value) Indicates whether comments could be attached.
void	setEmail(java.lang.String value) Sets the email of singer.
void	setId(java.util.UUID value) Sets identifier for this signature line.
void	setInstructions(java.lang.String value) Sets the text shown to user at signing time.
void	setLine(boolean value) Indicates whether it is a signature line.
void	setProviderId(java.util.UUID value) Sets the id of signature provider.
void	setShowSignedDate(boolean value) Indicates whether show signed date.
void	setSignatureLineType(int value) Sets the signature type.
void	setSigner(java.lang.String value) Sets the signer.
void	setTitle(java.lang.String value) Sets the title of singer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SignatureLine

public SignatureLine()

Method Detail

getId

public java.util.UUID getId()

Gets identifier for this signature line.

Example

 
         // Create signature line object
         SignatureLine s1 = new SignatureLine();
         s1.setId(java.util.UUID.randomUUID());
 

setId

public void setId(java.util.UUID value)

Sets identifier for this signature line.

getProviderId

public java.util.UUID getProviderId()

Gets the id of signature provider.

Remarks

It's typically the CLSID of the provider com add-in.

Example

 
         // Create signature line object
         SignatureLine s2 = new SignatureLine();
         s2.setProviderId(java.util.UUID.fromString("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"));//The GUID should be obtained from the documentation shipped with the provider.
 

setProviderId

public void setProviderId(java.util.UUID value)

Sets the id of signature provider.

Remarks

It's typically the CLSID of the provider com add-in.

getSigner

public java.lang.String getSigner()

Gets the signer.

Example

 
         // Create signature line object
         SignatureLine s3 = new SignatureLine();
         s3.setSigner("Mr xxx");
 

setSigner

public void setSigner(java.lang.String value)

Sets the signer.

getTitle

public java.lang.String getTitle()

Gets the title of singer.

Example

 
         // Create signature line object
         SignatureLine s4 = new SignatureLine();
         s4.setTitle("Development Lead");
 

setTitle

public void setTitle(java.lang.String value)

Sets the title of singer.

getEmail

public java.lang.String getEmail()

Gets the email of singer.

Example

 
         // Create signature line object
         SignatureLine s5 = new SignatureLine();
         s5.setEmail("Simon.Zhao@aspose.com");
 

setEmail

public void setEmail(java.lang.String value)

Sets the email of singer.

isLine

public boolean isLine()

Indicates whether it is a signature line.

Example

 
         if(s.isLine())
         {
             //Is line.
         }
 

setLine

public void setLine(boolean value)

Indicates whether it is a signature line.

getAllowComments

public boolean getAllowComments()

Indicates whether comments could be attached.

Example

 
         if(s.getAllowComments())
         {
             // Comments could be attached.
         }
 

setAllowComments

public void setAllowComments(boolean value)

Indicates whether comments could be attached.

getShowSignedDate

public boolean getShowSignedDate()

Indicates whether show signed date.

Example

 
         if(s.getShowSignedDate())
         {
             //Show signed date.
         }
 

setShowSignedDate

public void setShowSignedDate(boolean value)

Indicates whether show signed date.

getInstructions

public java.lang.String getInstructions()

Gets the text shown to user at signing time.

Example

 
         // Create signature line object
         SignatureLine s6 = new SignatureLine();
         s6.setInstructions("Just do it.");
 

setInstructions

public void setInstructions(java.lang.String value)

Sets the text shown to user at signing time.

getSignatureLineType

public int getSignatureLineType()

Gets the signature type. Default - When the default value is set, the corresponding ProviderId value is fixed to {0000000000-0000-0000-0000-0000000000}. Stamp - When the value is Stamp, the corresponding ProviderId value is usually {000CD6A4-0000-0000-C000-000000000046}. Custom - When the value is Custom, the corresponding ProviderId value usually needs to be set by the user. it should be obtained from the documentation shipped with the provider.

See SignatureType.

setSignatureLineType

public void setSignatureLineType(int value)

Sets the signature type. Default - When the default value is set, the corresponding ProviderId value is fixed to {0000000000-0000-0000-0000-0000000000}. Stamp - When the value is Stamp, the corresponding ProviderId value is usually {000CD6A4-0000-0000-C000-000000000046}. Custom - When the value is Custom, the corresponding ProviderId value usually needs to be set by the user. it should be obtained from the documentation shipped with the provider.

See SignatureType.