ImageSignOptions class
ImageSignOptions class
Represents the Image signature options.
Inheritance: ImageSignOptions →
SignOptions
The ImageSignOptions type exposes the following members:
Constructors
| Constructor | Description |
|---|---|
| init | Initializes a new instance of the ImageSignOptions class with default values. |
| init | Initializes a new instance of the ImageSignOptions class with image file. |
| init | Initializes a new instance of the ImageSignOptions class with image stream. |
Properties
| 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 |
Methods
| Method | Description |
|---|---|
| from_base64 | Creates a new instance of the ImageSignOptions class with predefined Image from Base64. |
Remarks
Learn more | | | |
See Also
- module
groupdocs.signature.options - class
DocumentType - class
ImageSignOptions - class
MeasureType - class
SignOptions - class
SignatureType