DigitalSignOptions

Inheritance: java.lang.Object, com.groupdocs.signature.options.sign.SignOptions, com.groupdocs.signature.options.sign.ImageSignOptions

public class DigitalSignOptions extends ImageSignOptions

Represents the Digital signature options.

Constructors

Constructor	Description
DigitalSignOptions()	Initializes a new instance of the DigitalSignOptions class with default values.
DigitalSignOptions(String certificateFilePath)	Initializes a new instance of the DigitalSignOptions class with certificate file.
DigitalSignOptions(InputStream certificateStream)	Initializes a new instance of the DigitalSignOptions class with certificate stream.
DigitalSignOptions(String certificateFilePath, String imageFilePath)	Initializes a new instance of the DigitalSignOptions class with certificate file and image file.
DigitalSignOptions(String certificateFilePath, InputStream appearenceImageStream)	Initializes a new instance of the DigitalSignOptions class with certificate file and image stream.
DigitalSignOptions(InputStream certificateStream, String imageFilePath)	Initializes a new instance of the DigitalSignOptions class with certificate stream and image file.
DigitalSignOptions(InputStream certificateStream, InputStream appearenceImageStream)	Initializes a new instance of the DigitalSignOptions class with certificate stream and image stream.

Methods

Method	Description
getReason()	Gets or sets the reason of signature.
setReason(String value)	Gets or sets the reason of signature.
getContact()	Gets or sets the signature contact.
setContact(String value)	Gets or sets the signature contact.
getLocation()	Gets or sets the signature location.
setLocation(String value)	Gets or sets the signature location.
getPassword()	Gets or sets the password of digital certificate.
setPassword(String value)	Gets or sets the password of digital certificate.
getSignature()	Gets or sets properties of document digital signature.
setSignature(DigitalSignature value)	Gets or sets properties of document digital signature.
getCertificateFilePath()	Gets or sets the digital certificate file path.
setCertificateFilePath(String value)	Gets or sets the digital certificate file GUID.
getCertificateStream()	Gets or sets digital certificate stream.
setCertificateStream(InputStream value)	Gets or sets digital certificate stream.
getVisible()	Gets or sets the visibility of signature.
setVisible(boolean value)	Gets or sets the visibility of signature.
getXAdESType()	XAdES type XAdESType .
setXAdESType(int value)	XAdES type XAdESType .
getSignatureLineId()
setSignatureLineId(UUID value)
toString()	Override string conversion.

DigitalSignOptions()

public DigitalSignOptions()

Initializes a new instance of the DigitalSignOptions class with default values.

DigitalSignOptions(String certificateFilePath)

public DigitalSignOptions(String certificateFilePath)

Initializes a new instance of the DigitalSignOptions class with certificate file.

Parameters:

Parameter	Type	Description
certificateFilePath	java.lang.String	Digital certificate file path

DigitalSignOptions(InputStream certificateStream)

public DigitalSignOptions(InputStream certificateStream)

Initializes a new instance of the DigitalSignOptions class with certificate stream.

Parameters:

Parameter	Type	Description
certificateStream	java.io.InputStream	Digital Certificate stream

DigitalSignOptions(String certificateFilePath, String imageFilePath)

public DigitalSignOptions(String certificateFilePath, String imageFilePath)

Initializes a new instance of the DigitalSignOptions class with certificate file and image file.

Parameters:

Parameter	Type	Description
certificateFilePath	java.lang.String	Digital certificate file path
imageFilePath	java.lang.String	Signature Appearance image file path

DigitalSignOptions(String certificateFilePath, InputStream appearenceImageStream)

public DigitalSignOptions(String certificateFilePath, InputStream appearenceImageStream)

Initializes a new instance of the DigitalSignOptions class with certificate file and image stream.

Parameters:

Parameter	Type	Description
certificateFilePath	java.lang.String	Digital certificate file path
appearenceImageStream	java.io.InputStream	Signature Appearance image stream

DigitalSignOptions(InputStream certificateStream, String imageFilePath)

public DigitalSignOptions(InputStream certificateStream, String imageFilePath)

Initializes a new instance of the DigitalSignOptions class with certificate stream and image file.

Parameters:

Parameter	Type	Description
certificateStream	java.io.InputStream	Digital Certificate stream
imageFilePath	java.lang.String	Signature Appearance image file path

DigitalSignOptions(InputStream certificateStream, InputStream appearenceImageStream)

public DigitalSignOptions(InputStream certificateStream, InputStream appearenceImageStream)

Initializes a new instance of the DigitalSignOptions class with certificate stream and image stream.

Parameters:

Parameter	Type	Description
certificateStream	java.io.InputStream	Digital Certificate stream
appearenceImageStream	java.io.InputStream	Signature Appearance image stream

getReason()

public final String getReason()

Gets or sets the reason of signature.

Returns: java.lang.String

setReason(String value)

public final void setReason(String value)

Gets or sets the reason of signature.

Parameters:

Parameter	Type	Description
value	java.lang.String

getContact()

public final String getContact()

Gets or sets the signature contact.

Returns: java.lang.String

setContact(String value)

public final void setContact(String value)

Gets or sets the signature contact.

Parameters:

Parameter	Type	Description
value	java.lang.String

getLocation()

public final String getLocation()

Gets or sets the signature location.

Returns: java.lang.String

setLocation(String value)

public final void setLocation(String value)

Gets or sets the signature location.

Parameters:

Parameter	Type	Description
value	java.lang.String

getPassword()

public final String getPassword()

Gets or sets the password of digital certificate.

Returns: java.lang.String

setPassword(String value)

public final void setPassword(String value)

Gets or sets the password of digital certificate.

Parameters:

Parameter	Type	Description
value	java.lang.String

getSignature()

public final DigitalSignature getSignature()

Gets or sets properties of document digital signature.

Returns: DigitalSignature

setSignature(DigitalSignature value)

public final void setSignature(DigitalSignature value)

Gets or sets properties of document digital signature.

Parameters:

Parameter	Type	Description
value	DigitalSignature

getCertificateFilePath()

public final String getCertificateFilePath()

Gets or sets the digital certificate file path. This property is used only if CertificateStream is not specified.

Returns: java.lang.String

setCertificateFilePath(String value)

public void setCertificateFilePath(String value)

Gets or sets the digital certificate file GUID. This property is used only if CertificateStream is not specified.

Parameters:

Parameter	Type	Description
value	java.lang.String

getCertificateStream()

public final InputStream getCertificateStream()

Gets or sets digital certificate stream. If this property is specified it is always used instead CertificateGuid.

Returns: java.io.InputStream

setCertificateStream(InputStream value)

public final void setCertificateStream(InputStream value)

Gets or sets digital certificate stream. If this property is specified it is always used instead CertificateGuid.

Parameters:

Parameter	Type	Description
value	java.io.InputStream

getVisible()

public final boolean getVisible()

Gets or sets the visibility of signature.

Returns: boolean

setVisible(boolean value)

public final void setVisible(boolean value)

Gets or sets the visibility of signature.

Parameters:

Parameter	Type	Description
value	boolean

getXAdESType()

public final int getXAdESType()

XAdES type XAdESType . Default value is None (XAdES is off). At this moment XAdES signature type is supported only for Spreadsheet documents under .NET Framework only (not under .NET Standard)

Returns: int

setXAdESType(int value)

public final void setXAdESType(int value)

XAdES type XAdESType . Default value is None (XAdES is off). At this moment XAdES signature type is supported only for Spreadsheet documents under .NET Framework only (not under .NET Standard)

Parameters:

Parameter	Type	Description
value	int

getSignatureLineId()

public final UUID getSignatureLineId()

Returns: java.util.UUID

setSignatureLineId(UUID value)

public final void setSignatureLineId(UUID value)

Parameters:

Parameter	Type	Description
value	java.util.UUID

toString()

public String toString()

Override string conversion.

Returns: java.lang.String -