DigitalSignOptions Leave feedback
On this page
Represents the Digital signature options.
public class DigitalSignOptions : ImageSignOptions
| 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. |
| Name | Description |
|---|---|
| virtual AllPages { get; set; } | Put signature on all document pages. |
| Appearance { get; set; } | Additional signature appearance. |
| Border { get; set; } | Specify border settings |
| CertificateFilePath { get; set; } | Gets or sets the digital certificate file path. This property is used only if CertificateStream is not specified. |
| CertificateStream { get; set; } | Gets or sets digital certificate stream. If this property is specified it is always used instead CertificateFilePath. |
| Contact { get; set; } | Gets or sets the signature contact. |
| CustomSignHash { get; set; } | Gets or sets a custom hash signing function, allowing users to implement their own digital signing logic. This enables signing with external certificates and supports different hash algorithms. |
| DocumentType { get; set; } | Get or set the Document Type of the Signature Options DocumentType |
| Extensions { get; } | Signature Extensions. |
| HashAlgorithm { get; set; } | Gets or sets the hash algorithm to be used for cryptographic operations. Supported exclusively for digital signatures in PDF files. |
| Height { get; set; } | Height of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType SizeMeasureType). |
| HorizontalAlignment { get; set; } | Horizontal alignment of signature on document page. |
| ImageFilePath { get; set; } | Gets or sets the signature image file path. This property is used only if ImageStream is not specified. |
| ImageStream { get; set; } | Gets or sets the signature image stream. If this property is specified it is always used instead ImageFilePath. |
| virtual Left { get; set; } | 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). |
| Location { get; set; } | Gets or sets the signature location. |
| virtual LocationMeasureType { get; set; } | Measure type (pixels, percents or millimeters) for Left and Top properties. |
| virtual Margin { get; set; } | Gets or sets the space between Sign and Document edges. (works ONLY if horizontal or vertical alignment are specified). |
| virtual MarginMeasureType { get; set; } | Gets or sets the measure type (pixels, percents or millimeters) for Margin. |
| virtual PageNumber { get; set; } | Gets or sets document page number for signing. Minimal and default value is 1. |
| virtual PagesSetup { get; set; } | Options to specify pages to be signed. |
| Password { get; set; } | Gets or sets the password of digital certificate. |
| Reason { get; set; } | Gets or sets the reason of signature. |
| Rectangle { get; } | Rectangle of area to put the image on document. |
| RotationAngle { get; set; } | Rotation angle of signature on document page (clockwise). |
| ShapePosition { get; set; } | Defines where shape should be presented in the document layout. Avaliable only for Word documents |
| Signature { get; set; } | Gets or sets properties of document digital signature. For signing Pdf documents it is possible to set advanced properties by using instance of PdfDigitalSignature |
| SignatureType { get; } | Get the Signature Type SignatureType |
| virtual SizeMeasureType { get; set; } | Measure type (pixels, percents or millimeters) for Width and Height properties. |
| Stretch { get; set; } | Stretch mode on Document Page. |
| virtual Top { get; set; } | 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). |
| Transparency { get; set; } | Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque). |
| UseLtv { get; set; } | Gets/sets ltv(Long Term Validation) validation flag. |
| VerticalAlignment { get; set; } | Vertical alignment of signature on document page. |
| Visible { get; set; } | Gets or sets the visibility of signature. |
| Width { get; set; } | Width of Signature on Document Page in Measure values (pixels, percents or millimeters MeasureType SizeMeasureType). |
| XAdESType { get; set; } | XAdES type XAdESType. Default value is None (XAdES is off). At this moment XAdES signature type is supported only for Spreadsheet documents. |
| ZOrder { get; set; } | Gets or sets the Z-order position of text signature. Determines the display order of overlapping signatures. |
| Name | Description |
|---|---|
| Dispose() | Clears internal resources |
Learn 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
- class ImageSignOptions
- namespace GroupDocs.Signature.Options
- assembly GroupDocs.Signature
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
