Search for Form Field e-Signatures Leave feedback
GroupDocs.Signature provides the ability to search for form field electronic signatures in documents. Form field signatures allow you to add interactive form elements like text boxes, checkboxes, and radio buttons to your documents.
The Signature class provides the search method which allows you to search for form field signatures in documents. Here’s how to use it:
- Create a new instance of the Signature class and pass the source document path as a parameter.
- Create an instance of FormFieldSearchOptions class.
- Call the search method of the Signature class instance and pass a list with the search options to it.
- Process the search results: the
signaturesproperty of the returned SearchResult holds the found FormFieldSignature objects.
Here’s an example of how to search for form field signatures in a document. A PDF digital signature is kept in a signature form field, so it is listed too, with the DIGITAL_SIGNATURE type:
from groupdocs.signature import Signature
from groupdocs.signature.options import FormFieldSearchOptions
def search_form_fields():
with Signature("signed.pdf") as signature:
result = signature.search([FormFieldSearchOptions()])
print(f"Found {len(result.signatures)} form field signature(s)")
for field in result.signatures:
print(f"Page {field.page_number}: {field.type.name} field {field.name!r}, value: {field.value!r}")
if __name__ == "__main__":
search_form_fields()
signed.pdf is the sample file used in this example. Click here to download it.
Found 3 form field signature(s)
Page 1: TEXT field 'ApprovedBy', value: 'John Smith'
Page 1: CHECKBOX field 'Confirmed', value: True
Page 1: DIGITAL_SIGNATURE field None, value: None
You can customize the search process with the name, type (FormFieldType) and value properties of FormFieldSearchOptions:
from groupdocs.signature import Signature
from groupdocs.signature.domain import FormFieldType
from groupdocs.signature.options import FormFieldSearchOptions
def search_form_fields_by_name():
with Signature("signed.pdf") as signature:
options = FormFieldSearchOptions()
# Return only text fields named "ApprovedBy"
options.type = FormFieldType.TEXT
options.name = "ApprovedBy"
result = signature.search([options])
print(f"Found {len(result.signatures)} matching form field signature(s)")
for field in result.signatures:
print(f"Field '{field.name}' on page {field.page_number}, value: {field.value}")
if __name__ == "__main__":
search_form_fields_by_name()
signed.pdf is the sample file used in this example. Click here to download it.
Found 1 matching form field signature(s)
Field 'ApprovedBy' on page 1, value: John Smith
You may easily run the code above and see the feature in action in our GitHub examples:
Along with the full-featured Python library, we provide simple but powerful free online apps.
To sign PDF, Word, Excel, PowerPoint, and other documents you can use the online apps from the GroupDocs.Signature App Product Family.
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.
