pdftools_sdk.sign.signature_field_options

Classes

Options for adding unsigned signature fields

class pdftools_sdk.sign.signature_field_options.SignatureFieldOptions(bounding_box: Appearance)[source]

Bases: _NativeObject

Options for adding unsigned signature fields

These options control the creation of unsigned signature fields in pdftools_sdk.sign.signer.Signer.add_signature_field.

__init__(bounding_box: Appearance)[source]

Parameters:: boundingBox (Appearance) – The bounding box of the signature field
Raises:: ValueError – If the boundingBox argument is None or not a valid bounding box

property bounding_box: Appearance

The bounding box of the signature field

The bounding box is the area where the visual appearance of the signature is inserted, when the signature field is signed.

Use pdftools_sdk.sign.appearance.Appearance.create_field_bounding_box to create the bounding box object.

property field_name: str | None

The name of the new signature field

If None, a new signature field is created using a unique field name.

Default: None