com.aspose.words
Class SignOptions

java.lang.Object
    extended by com.aspose.words.SignOptions

public class SignOptions 
extends java.lang.Object

Allows to specify options for document signing.

Constructor Summary
SignOptions()
          
 
Property Getters/Setters Summary
java.lang.StringgetComments()
voidsetComments(java.lang.String value)
           Specifies comments on the digital signature. Default value is #Error Cref: F:System.String.Empty.
java.lang.StringgetDecryptionPassword()
voidsetDecryptionPassword(java.lang.String value)
           The password to decrypt source document. Default value is #Error Cref: F:System.String.Empty.
java.util.UUIDgetProviderId()
voidsetProviderId(java.util.UUID value)
           Specifies the class ID of the signature provider. Default value is #Error Cref: F:System.Guid.Empty.
java.util.UUIDgetSignatureLineId()
voidsetSignatureLineId(java.util.UUID value)
           Signature line identifier. Default value is #Error Cref: F:System.Guid.Empty.
byte[]getSignatureLineImage()
voidsetSignatureLineImage(byte[] value)
           The image that will be shown in associated SignatureLine. Default value is null.
java.util.DategetSignTime()
voidsetSignTime(java.util.Date value)
           The date of signing. Default value is #Error Cref: P:System.DateTime.Now.
 

Constructor Detail

SignOptions

public SignOptions()

Property Getters/Setters Detail

getComments/setComments

public java.lang.String getComments() / public void setComments(java.lang.String value)
Specifies comments on the digital signature. Default value is #Error Cref: F:System.String.Empty.

getDecryptionPassword/setDecryptionPassword

public java.lang.String getDecryptionPassword() / public void setDecryptionPassword(java.lang.String value)
The password to decrypt source document. Default value is #Error Cref: F:System.String.Empty. If OOXML document is encrypted, you should provide decryption password to decrypt source document before it will be signed. This is not required for documents in binary DOC format.

getProviderId/setProviderId

public java.util.UUID getProviderId() / public void setProviderId(java.util.UUID value)
Specifies the class ID of the signature provider. Default value is #Error Cref: F:System.Guid.Empty.

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.


getSignatureLineId/setSignatureLineId

public java.util.UUID getSignatureLineId() / public void setSignatureLineId(java.util.UUID value)
Signature line identifier. Default value is #Error Cref: F:System.Guid.Empty. When set, it associates SignatureLine with corresponding DigitalSignature.

getSignatureLineImage/setSignatureLineImage

public byte[] getSignatureLineImage() / public void setSignatureLineImage(byte[] value)
The image that will be shown in associated SignatureLine. Default value is null.

getSignTime/setSignTime

public java.util.Date getSignTime() / public void setSignTime(java.util.Date value)
The date of signing. Default value is #Error Cref: P:System.DateTime.Now.

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.