SignatureLine

Inheritance: java.lang.Object

public class SignatureLine

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");

Constructors

Constructor	Description
SignatureLine()

Methods

Method	Description
equals(Object arg0)
getAllowComments()	Indicates whether comments could be attached.
getClass()
getEmail()	Gets the email of singer.
getId()	Gets identifier for this signature line.
getInstructions()	Gets the text shown to user at signing time.
getProviderId()	Gets the id of signature provider.
getShowSignedDate()	Indicates whether show signed date.
getSignatureLineType()	Gets the signature type.
getSigner()	Gets the signer.
getTitle()	Gets the title of singer.
hashCode()
isLine()	Indicates whether it is a signature line.
notify()
notifyAll()
setAllowComments(boolean value)	Indicates whether comments could be attached.
setEmail(String value)	Sets the email of singer.
setId(UUID value)	Sets identifier for this signature line.
setInstructions(String value)	Sets the text shown to user at signing time.
setLine(boolean value)	Indicates whether it is a signature line.
setProviderId(UUID value)	Sets the id of signature provider.
setShowSignedDate(boolean value)	Indicates whether show signed date.
setSignatureLineType(int value)	Sets the signature type.
setSigner(String value)	Sets the signer.
setTitle(String value)	Sets the title of singer.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

SignatureLine()

public SignatureLine()

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

getAllowComments()

public boolean getAllowComments()

Indicates whether comments could be attached.

Example

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

Returns: boolean

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getEmail()

public String getEmail()

Gets the email of singer.

Example

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

Returns: java.lang.String

getId()

public UUID getId()

Gets identifier for this signature line.

Example

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

Returns: java.util.UUID

getInstructions()

public 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.");

Returns: java.lang.String

getProviderId()

public 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.

Returns: java.util.UUID

getShowSignedDate()

public boolean getShowSignedDate()

Indicates whether show signed date.

Example

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

Returns: boolean

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.

Returns: int

getSigner()

public String getSigner()

Gets the signer.

Example

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

Returns: java.lang.String

getTitle()

public String getTitle()

Gets the title of singer.

Example

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

Returns: java.lang.String

hashCode()

public native int hashCode()

Returns: int

isLine()

public boolean isLine()

Indicates whether it is a signature line.

Example

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

Returns: boolean

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setAllowComments(boolean value)

public void setAllowComments(boolean value)

Indicates whether comments could be attached.

Parameters:

Parameter	Type	Description
value	boolean

setEmail(String value)

public void setEmail(String value)

Sets the email of singer.

Parameters:

Parameter	Type	Description
value	java.lang.String

setId(UUID value)

public void setId(UUID value)

Sets identifier for this signature line.

Parameters:

Parameter	Type	Description
value	java.util.UUID

setInstructions(String value)

public void setInstructions(String value)

Sets the text shown to user at signing time.

Parameters:

Parameter	Type	Description
value	java.lang.String

setLine(boolean value)

public void setLine(boolean value)

Indicates whether it is a signature line.

Parameters:

Parameter	Type	Description
value	boolean

setProviderId(UUID value)

public void setProviderId(UUID value)

Sets the id of signature provider.

Remarks

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

Parameters:

Parameter	Type	Description
value	java.util.UUID

setShowSignedDate(boolean value)

public void setShowSignedDate(boolean value)

Indicates whether show signed date.

Parameters:

Parameter	Type	Description
value	boolean

setSignatureLineType(int value)

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.

Parameters:

Parameter	Type	Description
value	int

setSigner(String value)

public void setSigner(String value)

Sets the signer.

Parameters:

Parameter	Type	Description
value	java.lang.String

setTitle(String value)

public void setTitle(String value)

Sets the title of singer.

Parameters:

Parameter	Type	Description
value	java.lang.String

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int