DigitalSignOptions class Leave feedback
On this page
Represents the Digital signature options.
Inheritance: DigitalSignOptions →
ImageSignOptions →
SignOptions
The DigitalSignOptions type exposes the following members:
| Constructor | Description |
|---|---|
| init | Initializes a new instance of the DigitalSignOptions class with default values. |
| init | Initializes a new instance of the DigitalSignOptions class with certificate file. |
| init | Initializes a new instance of the DigitalSignOptions class with certificate stream. |
| init | Initializes a new instance of the DigitalSignOptions class with certificate file and image file. |
| init | Initializes a new instance of the DigitalSignOptions class with certificate file and image stream. |
| init | Initializes a new instance of the DigitalSignOptions class with certificate stream and image file. |
| init | Initializes a new instance of the DigitalSignOptions class with certificate stream and image stream. |
| Property | Description |
|---|---|
| page_number | Gets or sets document page number for signing.
Minimal and default value is 1. |
| all_pages | Put signature on all document pages. |
| appearance | Additional signature appearance. |
| extensions | Signature Extensions. |
| pages_setup | Options to specify pages to be signed. |
| signature_type | Get the Signature Type SignatureType |
| document_type | Get or set the Document Type of the Signature Options DocumentType |
| z_order | Gets or sets the Z-order position of text signature.
Determines the display order of overlapping signatures. |
| hash_algorithm | Gets or sets the hash algorithm to be used for cryptographic operations.
Supported exclusively for digital signatures in PDF files. |
| image_file_path | Gets or sets the signature image file path.
This property is used only if ImageStream is not specified. |
| image_stream | Gets or sets the signature image stream.
If this property is specified it is always used instead ImageFilePath. |
| 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). |
| 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). |
| width | Width of Signature on Document Page in Measure values
(pixels, percents or millimeters MeasureType SizeMeasureType). |
| height | Height of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType SizeMeasureType). |
| location_measure_type | Measure type (pixels, percents or millimeters) for Left and Top properties. |
| size_measure_type | Measure type (pixels, percents or millimeters) for Width and Height properties. |
| stretch | Stretch mode on Document Page. |
| rotation_angle | Rotation angle of signature on document page (clockwise). |
| horizontal_alignment | Horizontal alignment of signature on document page. |
| vertical_alignment | Vertical alignment of signature on document page. |
| margin | Gets or sets the space between Sign and Document edges.
(works ONLY if horizontal or vertical alignment are specified). |
| margin_measure_type | Gets or sets the measure type (pixels, percents or millimeters) for Margin. |
| transparency | Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque). |
| shape_position | Defines where shape should be presented in the document layout. Avaliable only for Word documents |
| rectangle | Rectangle of area to put the image on document. |
| border | Specify border settings |
| reason | Gets or sets the reason of signature. |
| contact | Gets or sets the signature contact. |
| location | Gets or sets the signature location. |
| password | Gets or sets the password of digital certificate. |
| 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 |
| certificate_file_path | Gets or sets the digital certificate file path.
This property is used only if CertificateStream is not specified. |
| certificate_stream | Gets or sets digital certificate stream.
If this property is specified it is always used instead CertificateFilePath. |
| visible | Gets or sets the visibility of signature. |
| use_ltv | Gets/sets ltv(Long Term Validation) validation flag. |
| custom_sign_hash | 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. |
| x_ad_es_type | XAdES type DigitalSignOptions.x_ad_es_type. Default value is None (XAdES is off).
At this moment XAdES signature type is supported only for Spreadsheet documents. |
| Method | Description |
|---|---|
| from_base64 | Creates a new instance of the ImageSignOptions class with predefined Image from Base64. |
Learn more | | | |
- module
groupdocs.signature.options - class
DigitalSignOptions - class
DocumentType - class
ImageSignOptions - class
MeasureType - class
PdfDigitalSignature - class
SignOptions - class
SignatureType
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.
