TextSearchOptions class Leave feedback
On this page
Represents search options for Text signatures.
Learn more:
- Basic usage of search for Text electronic signature by GroupDocs.Signature: How to eSearch Text signatures in a document
- Advanced usage of settings of search for Text electronic signature with GroupDocs.Signature: Advanced usage of eSearch Text signatures in a document and additional settings
The TextSearchOptions type exposes the following members:
| Constructor | Description |
|---|---|
| init | Initializes a new instance of the TextSearchOptions class with default values. |
| init | Initializes a new instance of the TextSearchOptions class with a text value. |
| Property | Description |
|---|---|
| match_type | The text match type used for searching. |
| signature_implementation | The text signature implementation to search. |
| text | The signature text to match when searching. |
| all_pages | The flag indicating whether to search on each document page. By default this value is True. (inherited from SearchOptions) |
| page_number | The document page number for searching (optional). (inherited from SearchOptions) |
| pages_setup | The options to specify pages for signature searching. (inherited from SearchOptions) |
| shape_position | The flag indicating whether to return the shape position in the document layout. Available only for Word documents. (inherited from SearchOptions) |
| skip_external | The flag to return only signatures marked as IsSignature. By default the value is False, which indicates that all signatures matching the specified criteria are returned. (inherited from SearchOptions) |
from groupdocs.signature import Signature
from groupdocs.signature.domain import TextMatchType, TextSignatureImplementation
from groupdocs.signature.options import TextSearchOptions
with Signature("signed.pdf") as signature:
options = TextSearchOptions()
options.all_pages = False
options.page_number = 1
options.text = "John"
options.match_type = TextMatchType.CONTAINS
options.signature_implementation = TextSignatureImplementation.NATIVE
result = signature.search([options])
print(f"Found {len(result.signatures)} matching text signature(s)")
for ts in result.signatures:
print(f"'{ts.text}' on page {ts.page_number} at ({ts.left}, {ts.top}), size {ts.width}x{ts.height}")
Task guides that use TextSearchOptions:
- module
groupdocs.signature.options
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.
