TextFormFieldSignature class

TextFormFieldSignature class

Represents text input form field signature properties for PDF documents.

The TextFormFieldSignature type exposes the following members:

Constructors

Constructor Description
init Initializes a PdfTextFormFieldSignature with a predefined name.
init Initializes a PdfTextFormFieldSignature with a predefined name.

Methods

Method Description
clone Clone FormField Signature instance.
equals Compares this signature with another signature for equality based on type and property values.
equals_object
get_hash_code Overrides GetHashCode method.

Properties

Property Description
text The text of the form field input.
created_on The signature creation date. (inherited from BaseSignature)
deleted The flag indicating whether this signature was deleted from the document. (inherited from BaseSignature)
height The height of the signature. (inherited from BaseSignature)
is_signature The flag indicating whether this component represents a signature (True) or document content (False). (inherited from BaseSignature)
left The left position of the signature. (inherited from BaseSignature)
modified_on The signature modification date. (inherited from BaseSignature)
name The unique form field name. (inherited from FormFieldSignature)
page_number The page number where the signature was found. (inherited from BaseSignature)
signature_id The unique identifier of the signature, used to modify the signature in the document via update or delete operations. (inherited from BaseSignature)
signature_type The type of signature. (inherited from BaseSignature)
top The top position of the signature. (inherited from BaseSignature)
type The Form field type. (inherited from FormFieldSignature)
value The form field data object. (inherited from FormFieldSignature)
width The width of the signature. (inherited from BaseSignature)

Example

from groupdocs.signature import Signature
from groupdocs.signature.options import FormFieldSignOptions
from groupdocs.signature.domain import TextFormFieldSignature


def sign_with_form_field_signature():
    with Signature("sample.pdf") as signature:
        # Create a text form field named "FieldText" with the value "Value1"
        text_field = TextFormFieldSignature("FieldText", "Value1")

        # Create form field options for it
        options = FormFieldSignOptions(text_field)

        # Set form field position and size
        options.left = 100
        options.top = 400
        options.width = 200
        options.height = 20

        # Sign the document and save the result
        result = signature.sign("signed_form_field.pdf", options)
        for field in result.succeeded:
            print(f"Added form field '{field.name}' with value '{field.value}'")

See Also