BarcodeVerifyOptions class

BarcodeVerifyOptions class

Represents the Barcode verify options.

Learn more

The BarcodeVerifyOptions type exposes the following members:

Constructors

Constructor Description
init Initializes default verification option for barcode signature.
init Initializes a default verification option with verification text.
init Initializes a default verification option with barcode type verification.
init Initializes a default verification option with barcode type verification and text.

Properties

Property Description
encode_type The barcode type used for verification.
all_pages The flag indicating whether each document page should be verified. By default the value is True. (inherited from VerifyOptions)
extensions The additional extensions for alternative signature options verification. (inherited from VerifyOptions)
form_text_field_title The title of the form field to verify. If set, the text will be found only in text form fields. (inherited from TextVerifyOptions)
form_text_field_type The type of form field to verify; if set, text will be found only in text form fields. (inherited from TextVerifyOptions)
is_valid The valid property flag. (inherited from VerifyOptions)
match_type The text match type verification. (inherited from TextVerifyOptions)
page_number The document page number to be verified; if not set, all pages of the document are verified for the first occurrence (minimum value is 1). (inherited from VerifyOptions)
pages_setup The page options to specify pages to be verified. (inherited from VerifyOptions)
shape_position The shape position in the document layout used for verifying signatures in headers/footers. (inherited from VerifyOptions)
signature_id The Text Signature ID to verify. Must be greater than zero; supported only for PDF documents. (inherited from TextVerifyOptions)
signature_implementation The type of signature to be verified. (inherited from TextVerifyOptions)
text The signature text to verify. (inherited from TextVerifyOptions)

Example

from groupdocs.signature import Signature
from groupdocs.signature.domain import TextMatchType
from groupdocs.signature.options import BarcodeVerifyOptions


def verify_barcode_signatures():
    with Signature("signed.pdf") as signature:
        options = BarcodeVerifyOptions()
        options.all_pages = True
        options.text = "12345"
        options.match_type = TextMatchType.CONTAINS

        result = signature.verify(options)

        if result.is_valid:
            print(f"Document was verified successfully: {len(result.succeeded)} matching barcode signature(s).")
        else:
            print("Document failed verification process.")

See Also