QrCodeSearchOptions class Leave feedback
On this page
Represents search options for QR-Code signatures.
- Basic usage of search for QR-Code electronic signature by GroupDocs.Signature: How to eSearch QR-Code signatures in a document (https://docs.groupdocs.com/display/signaturenet/Search+for+QR-Code+e-signatures)
- Advanced usage of settings of search for QR-Code electronic signature with GroupDocs.Signature: Advanced usage of eSearch QR-Code signatures in a document and additional settings (https://docs.groupdocs.com/display/signaturenet/Advanced+search+for+QR-code+signatures)
The QrCodeSearchOptions type exposes the following members:
| Constructor | Description |
|---|---|
| init | Initializes a new instance of the QRCodeSearchOptions class with default values. |
| init | Initializes a new instance of the QRCodeSearchOptions class with encode type value. |
| init | Initializes a new instance of the QRCodeSearchOptions class with encode type and text values. |
| Property | Description |
|---|---|
| data_encryption | The implementation of IDataEncryption used to encode and decode QR-Code signature text or data properties. |
| encode_type | The encode type to search for QR codes. |
| match_type | The QR-Code text match type used during search. |
| return_content | The flag that determines whether QR‑Code image content is returned for each signature on a document page. When set to True, the raw image data is kept in the signature’s content property using the format specified by return_content_type. Disabled by default. |
| return_content_type | The file type of the returned image content of the QR-Code signature when the return_content property is enabled. |
| text | The QR-Code signature text to search and match. |
| 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.options import QrCodeSearchOptions
with Signature("signed.pdf") as signature:
result = signature.search([QrCodeSearchOptions()])
print(f"Found {len(result.signatures)} QR code signature(s)")
for qr in result.signatures:
print(f"QR code signature found at page {qr.page_number} with type {qr.encode_type.type_name} and text '{qr.text}'")
- 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.
