| DigitalSignOptions Class |
Represents the Digital signature options.
Inheritance HierarchySystemObject
GroupDocs.Signature.OptionsSignOptions
GroupDocs.Signature.OptionsImageSignOptions
GroupDocs.Signature.OptionsDigitalSignOptions
GroupDocs.Signature.OptionsSignOptions
GroupDocs.Signature.OptionsImageSignOptions
GroupDocs.Signature.OptionsDigitalSignOptions
Namespace: GroupDocs.Signature.Options
Assembly: GroupDocs.Signature (in GroupDocs.Signature.dll) Version: 20.10.0.0 (20.10)
SyntaxThe DigitalSignOptions type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | DigitalSignOptions |
Initializes a new instance of the DigitalSignOptions class with default values.
|
| DigitalSignOptions(Stream) |
Initializes a new instance of the DigitalSignOptions class with certificate stream.
|
| DigitalSignOptions(String) |
Initializes a new instance of the DigitalSignOptions class with certificate file.
|
| DigitalSignOptions(Stream, Stream) |
Initializes a new instance of the DigitalSignOptions class with certificate stream and image stream.
|
| DigitalSignOptions(Stream, String) |
Initializes a new instance of the DigitalSignOptions class with certificate stream and image file.
|
| DigitalSignOptions(String, Stream) |
Initializes a new instance of the DigitalSignOptions class with certificate file and image stream.
|
| DigitalSignOptions(String, String) |
Initializes a new instance of the DigitalSignOptions class with certificate file and image file.
|
Properties| Name | Description | |
|---|---|---|
 | AllPages |
Put signature on all document pages.
This property can only be used for multi-frames image formats (Tiff).
(Inherited from ImageSignOptions.) |
| Appearance |
Additional signature appearance.
(Inherited from SignOptions.) |
| Border |
Specify border settings
(Inherited from ImageSignOptions.) |
| CertificateFilePath |
Gets or sets the digital certificate file path.
This property is used only if CertificateStream is not specified.
|
| CertificateStream |
Gets or sets digital certificate stream.
If this property is specified it is always used instead CertificateFilePath.
|
| Contact |
Gets or sets the signature contact.
|
| Extensions |
Signature Extensions.
(Inherited from SignOptions.) |
| Height |
Height of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType SizeMeasureType).
(Inherited from ImageSignOptions.) |
| HorizontalAlignment |
Horizontal alignment of signature on document page.
(Inherited from ImageSignOptions.) |
| ImageFilePath |
Gets or sets the signature image file path.
This property is used only if ImageStream is not specified.
(Inherited from ImageSignOptions.) |
| ImageStream |
Gets or sets the signature image stream.
If this property is specified it is always used instead ImageFilePath.
(Inherited from ImageSignOptions.) |
| Left |
Left X position of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType LocationMeasureType).
(works if horizontal alignment is not specified).
(Inherited from ImageSignOptions.) |
| Location |
Gets or sets the signature location.
|
| LocationMeasureType |
Measure type (pixels, percents or millimeters) for Left and Top properties.
(Inherited from ImageSignOptions.) |
| Margin |
Gets or sets the space between Sign and Document edges.
(works ONLY if horizontal or vertical alignment are specified).
(Inherited from ImageSignOptions.) |
| MarginMeasureType |
Gets or sets the measure type (pixels, percents or millimeters) for Margin.
(Inherited from ImageSignOptions.) |
| PageNumber |
Gets or sets document page number for signing.
Minimal and default value is 1.
(Inherited from SignOptions.) |
| PagesSetup |
Options to specify pages to be signed.
(Inherited from SignOptions.) |
| Password |
Gets or sets the password of digital certificate.
|
| Reason |
Gets or sets the reason of signature.
|
| Rectangle |
Rectangle of area to put the image on document.
(Inherited from ImageSignOptions.) |
| RotationAngle |
Rotation angle of signature on document page (clockwise).
(Inherited from ImageSignOptions.) |
| Signature |
Gets or sets properties of document digital signature.
For signing Pdf documents it is possible to set advanced properties by using instance of PdfDigitalSignature |
| SizeMeasureType |
Measure type (pixels, percents or millimeters) for Width and Height properties.
(Inherited from ImageSignOptions.) |
| Stretch |
Stretch mode on Document Page.
(Inherited from ImageSignOptions.) |
| Top |
Top Y Position of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType LocationMeasureType).
(works if vertical alignment is not specified).
(Inherited from ImageSignOptions.) |
| Transparency |
Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque).
(Inherited from ImageSignOptions.) |
| VerticalAlignment |
Vertical alignment of signature on document page.
(Inherited from ImageSignOptions.) |
| Visible |
Gets or sets the visibility of signature.
|
| Width |
Width of Signature on Document Page in Measure values
(pixels, percents or millimeters MeasureType SizeMeasureType).
(Inherited from ImageSignOptions.) |
| XAdESType |
XAdES type XAdESType. Default value is None (XAdES is off).
At this moment XAdES signature type is supported only for Spreadsheet documents.
|
Methods| Name | Description | |
|---|---|---|
| Equals | (Inherited from Object.) |
 | Finalize | (Inherited from Object.) |
| GetHashCode | (Inherited from Object.) |
| GetType | (Inherited from Object.) |
| MemberwiseClone | (Inherited from Object.) |
| ToString | (Inherited from Object.) |
RemarksLearn more
- Basic usage of creating Digital electronic signature by GroupDocs.Signature: How to eSign document with Digital signature
- Advanced usage of settings of Digital electronic signature with GroupDocs.Signature: Advanced usage to eSign document with Digital signature and additional settings
See Also