StampSignOptions class Leave feedback

StampSignOptions class

Represents the Stamp signature options.

Learn more:

Basic usage of creating Stamp electronic signature by GroupDocs.Signature: How to eSign document with Stamp signature (https://docs.groupdocs.com/display/signaturenet/eSign+document+with+Stamp+signature)
Advanced usage of settings of Stamp electronic signature with GroupDocs.Signature: Advanced usage to eSign document with Stamp signature and additional settings (https://docs.groupdocs.com/display/signaturenet/Sign+document+with+Stamp+signature+-+advanced)

The StampSignOptions type exposes the following members:

Constructors

Constructor	Description
init	Initializes a new instance of the StampSignOptions class with default values.
init	Initializes a new instance of the StampSignOptions class with alignment options.

Methods

Method	Description
dispose	Clears internal resources. (inherited from `ImageSignOptions`)
from_base64	Creates a new ImageSignOptions instance with a predefined image from a Base64 string. (inherited from `ImageSignOptions`)

Properties

Property	Description
background	The background of the stamp.
background_color_crop_type	The background color crop type of the signature.
background_image_crop_type	The background image crop type of the signature.
height	The height of the signature area on the document page in measure units (pixels, percents, or millimeters).
horizontal_alignment	The horizontal alignment of the image on a document page.
inner_lines	The list of inner lines rendered as a set of rectangles.
left	The left X position of the signature area on the document page in measure units (pixels, percents, or millimeters). See `MeasureType` `LocationMeasureType`.
location_measure_type	The measure type (pixels, percents or millimeters) for the left and top properties.
margin	The space that is specified by default between the image and document edges (works if horizontal or vertical alignment is specified).
margin_measure_type	The margin measurement type (pixels, percents or millimeters).
outer_lines	The list of outer lines rendered as concentric circles.
rotation_angle	The rotation angle clockwise.
size_measure_type	The measure type (pixels, percents or millimeters) for Width and Height properties.
stamp_type	The stamp type. Default is `Round`.
stretch	The stretch mode on the document page.
top	The top Y position of the signature area on the document page in measure units (pixels, percents, or millimeters). See `MeasureType` `LocationMeasureType`.
transparency	The transparency of the stamp signature. The value ranges from 0.0 to 1.0, with a default of 0.
vertical_alignment	The vertical alignment of the stamp on a document page.
width	The width of the signature area on the document page in measure values (pixels, percents, or millimeters). The measurement unit is defined by `MeasureType` SizeMeasureType.
all_pages	The signature will be placed on all document pages. (inherited from `SignOptions`)
appearance	The additional signature appearance. (inherited from `SignOptions`)
border	The border settings for the image signature. (inherited from `ImageSignOptions`)
document_type	The document type of the signature options (`DocumentType`). (inherited from `SignOptions`)
extensions	The signature extensions. (inherited from `SignOptions`)
hash_algorithm	The hash algorithm to be used for cryptographic operations. Supported exclusively for digital signatures in PDF files. (inherited from `SignOptions`)
image_file_path	The file path of the signature image, used only if `image_stream` is not specified. (inherited from `ImageSignOptions`)
image_stream	The signature image stream. If specified, it is always used instead of ImageFilePath. (inherited from `ImageSignOptions`)
page_number	The document page number for signing. (inherited from `SignOptions`)
pages_setup	The options to specify pages to be signed. (inherited from `SignOptions`)
rectangle	The rectangle of area to put the image on document. (inherited from `ImageSignOptions`)
shape_position	The shape position defines where the shape should be presented in the document layout. Available only for Word documents. (inherited from `ImageSignOptions`)
signature_type	The signature type (`SignatureType`). (inherited from `SignOptions`)
zorder	The Z-order position of the text signature, which determines the display order of overlapping signatures. (inherited from `SignOptions`)

Example

from groupdocs.signature import Signature
from groupdocs.signature.options import StampSignOptions

with Signature("sample.docx") as signature:
    options = StampSignOptions()
    options.left = 380
    options.top = 520
    options.width = 160
    options.height = 160
    # configure additional stamp options as needed
    signature.sign(options)

StampSignOptions class Leave feedback

On this page

StampSignOptions class

Constructors

Methods

Properties

Example

See Also

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!

On this page