BarcodeSearchOptions class Leave feedback
On this page
Represents search options for Barcode signatures.
Inheritance: BarcodeSearchOptions →
SearchOptions
The BarcodeSearchOptions type exposes the following members:
| Constructor | Description |
|---|---|
| init | Initializes a new instance of the BarcodeSearchOptions class with default values. |
| init | Initializes a new instance of the BarcodeSearchOptions class with encode type value. |
| init | Initializes a new instance of the BarcodeSearchOptions class with encode type and text values. |
| Property | Description |
|---|---|
| page_number | Gets or sets Document page number for searching.
Value is optional. |
| pages_setup | Options to specify pages for Signature searching. |
| all_pages | Flag to search on each Document page. By default this value is set to true. |
| skip_external | Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria. |
| shape_position | Flag to return specify shape position in the document layout. Avaliable only for Word documents |
| encode_type | Specifies Encode Type property to search Barcodes.
If this value is not set, search is processed for all supported Barcode Types |
| text | Specifies Barcode Signature text if it should be searched and matched. |
| match_type | Gets or sets Barcode text Match Type search. It is used only when Text property is set. |
| return_content | Gets or sets flag to grab Barcode image content of signature on document page.
If this flag is set true, Barcode signature image content will keep raw image data by required format BarcodeSearchOptions.return_content_type.
By default this option is disabled. |
| return_content_type | Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled.
By default it set to Null. That means to return Barcode image content in original format. This image format is specified at BarcodeSignature.format
Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP. If provided format is not supported than Barcode image content in .png format will be returned. |
Learn more | | | |
- module
groupdocs.signature.options - class
BarcodeSearchOptions - class
SearchOptions
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.
