Packages

com.groupdocs.signature.options.sign

Classes

java.lang.Object
- com.groupdocs.signature.options.sign.SignOptions
- - com.groupdocs.signature.options.sign.ImageSignOptions
  - - com.groupdocs.signature.options.sign.DigitalSignOptions

All Implemented Interfaces:

com.aspose.ms.System.IDisposable, IAlignment, IRectangle, IRotation, ITransparency
```
public class DigitalSignOptions
extends ImageSignOptions
```
Represents the Digital signature options.

Constructor Summary

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

Method Summary

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

Methods inherited from class com.groupdocs.signature.options.sign.ImageSignOptions
dispose, fromBase64, getAllPages, getBorder, getHeight, getHorizontalAlignment, getImageFilePath, getImageStream, getLeft, getLocationMeasureType, getMargin, getMarginMeasureType, getRectangle, getRotationAngle, getSizeMeasureType, getStretch, getTop, getTransparency, getVerticalAlignment, getWidth, setAllPages, setBorder, setHeight, setHorizontalAlignment, setImageFilePath, setImageStream, setLeft, setLocationMeasureType, setMargin, setMarginMeasureType, setRotationAngle, setSizeMeasureType, setStretch, setTop, setTransparency, setVerticalAlignment, setWidth

Methods inherited from class com.groupdocs.signature.options.sign.SignOptions
addSignature, getAppearance, getDocumentType, getExtensions, getPageNumber, getPagesSetup, getSignatureType, getZOrder, setAppearance, setDocumentType, setExtensions, setPageNumber, setPagesSetup, setZOrder

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

- Constructor Detail
  - DigitalSignOptions
```
public DigitalSignOptions()
```
    Initializes a new instance of the DigitalSignOptions class with default values.
  - DigitalSignOptions
```
public DigitalSignOptions(InputStream certificateStream)
```
    Initializes a new instance of the DigitalSignOptions class with certificate stream.
    
    Parameters:
    
    certificateStream - Digital Certificate stream
  - DigitalSignOptions
```
public DigitalSignOptions(InputStream certificateStream,
                          InputStream appearenceImageStream)
```
    Initializes a new instance of the DigitalSignOptions class with certificate stream and image stream.
    
    Parameters:
    
    certificateStream - Digital Certificate stream
    
    appearenceImageStream - Signature Appearance image stream
  - DigitalSignOptions
```
public DigitalSignOptions(InputStream certificateStream,
                          String imageFilePath)
```
    Initializes a new instance of the DigitalSignOptions class with certificate stream and image file.
    
    Parameters:
    
    certificateStream - Digital Certificate stream
    
    imageFilePath - Signature Appearance image file path
  - DigitalSignOptions
```
public DigitalSignOptions(String certificateFilePath)
```
    Initializes a new instance of the DigitalSignOptions class with certificate file.
    
    Parameters:
    
    certificateFilePath - Digital certificate file path
  - DigitalSignOptions
```
public DigitalSignOptions(String certificateFilePath,
                          InputStream appearenceImageStream)
```
    Initializes a new instance of the DigitalSignOptions class with certificate file and image stream.
    
    Parameters:
    
    certificateFilePath - Digital certificate file path
    
    appearenceImageStream - Signature Appearance image stream
  - DigitalSignOptions
```
public DigitalSignOptions(String certificateFilePath,
                          String imageFilePath)
```
    Initializes a new instance of the DigitalSignOptions class with certificate file and image file.
    
    Parameters:
    
    certificateFilePath - Digital certificate file path
    
    imageFilePath - Signature Appearance image file path
- Method Detail
  - getCertificateFilePath
```
public final String getCertificateFilePath()
```
    Gets or sets the digital certificate file path. This property is used only if CertificateStream is not specified.
  - getCertificateStream
```
public final InputStream getCertificateStream()
```
    Gets or sets digital certificate stream. If this property is specified it is always used instead CertificateGuid.
  - getContact
```
public final String getContact()
```
    Gets or sets the signature contact.
  - getLocation
```
public final String getLocation()
```
    Gets or sets the signature location.
  - getPassword
```
public final String getPassword()
```
    Gets or sets the password of digital certificate.
  - getReason
```
public final String getReason()
```
    Gets or sets the reason of signature.
  - getSignature
```
public final DigitalSignature getSignature()
```
    Gets or sets properties of document digital signature.
  - getSignatureLineId
```
public final UUID getSignatureLineId()
```
  - getVisible
```
public final boolean getVisible()
```
    Gets or sets the visibility of signature.
  - 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)
  - setCertificateFilePath
```
public void setCertificateFilePath(String value)
```
    Gets or sets the digital certificate file GUID. This property is used only if CertificateStream is not specified.
  - setCertificateStream
```
public final void setCertificateStream(InputStream value)
```
    Gets or sets digital certificate stream. If this property is specified it is always used instead CertificateGuid.
  - setContact
```
public final void setContact(String value)
```
    Gets or sets the signature contact.
  - setLocation
```
public final void setLocation(String value)
```
    Gets or sets the signature location.
  - setPassword
```
public final void setPassword(String value)
```
    Gets or sets the password of digital certificate.
  - setReason
```
public final void setReason(String value)
```
    Gets or sets the reason of signature.
  - setSignature
```
public final void setSignature(DigitalSignature value)
```
    Gets or sets properties of document digital signature.
  - setSignatureLineId
```
public final void setSignatureLineId(UUID value)
```
  - setVisible
```
public final void setVisible(boolean value)
```
    Gets or sets the visibility of signature.
  - setXAdESType
```
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)
  - toString
```
public String toString()
```
    Override string conversion.
    
    Overrides:
    
    toString in class ImageSignOptions
    
    Returns:

Packages

com.groupdocs.signature.options.sign

Classes

Class DigitalSignOptions

Constructor Summary

Method Summary

Methods inherited from class com.groupdocs.signature.options.sign.ImageSignOptions

Methods inherited from class com.groupdocs.signature.options.sign.SignOptions

Methods inherited from class java.lang.Object

Constructor Detail

DigitalSignOptions

DigitalSignOptions

DigitalSignOptions

DigitalSignOptions

DigitalSignOptions

DigitalSignOptions

DigitalSignOptions

Method Detail

getCertificateFilePath

getCertificateStream

getContact

getLocation

getPassword

getReason

getSignature

getSignatureLineId

getVisible

getXAdESType

setCertificateFilePath

setCertificateStream

setContact

setLocation

setPassword

setReason

setSignature

setSignatureLineId

setVisible

setXAdESType

toString