BarcodeSearchOptions
Contents
[
Hide
]
BarcodeSearchOptions class
Represents search options for Barcode signatures.
public class BarcodeSearchOptions : SearchOptions
Constructors
| Name | Description |
|---|---|
| BarcodeSearchOptions() | Initializes a new instance of the BarcodeSearchOptions class with default values. |
| BarcodeSearchOptions(BarcodeType) | Initializes a new instance of the BarcodeSearchOptions class with encode type value. |
| BarcodeSearchOptions(BarcodeType, string) | Initializes a new instance of the BarcodeSearchOptions class with encode type and text values. |
Properties
| Name | Description |
|---|---|
| AllPages { get; set; } | Flag to search on each Document page. By default this value is set to true. |
| EncodeType { get; set; } | Specifies Encode Type property to search Barcodes. If this value is not set, search is processed for all supported Barcode Types |
| MatchType { get; set; } | Gets or sets Barcode text Match Type search. It is used only when Text property is set. |
| PageNumber { get; set; } | Gets or sets Document page number for searching. Value is optional. |
| PagesSetup { get; set; } | Options to specify pages for Signature searching. |
| ReturnContent { get; set; } | 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 ReturnContentType. By default this option is disabled. |
| ReturnContentType { get; set; } | 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 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. |
| ShapePosition { get; set; } | Flag to return specify shape position in the document layout. Avaliable only for Word documents |
| SkipExternal { get; set; } | Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria. |
| Text { get; set; } | Specifies Barcode Signature text if it should be searched and matched. |
Remarks
Learn more
- Basic usage of search for Barcode electronic signature by GroupDocs.Signature: How to eSearch Barcode signatures in a document
- Advanced usage of settings of search for Barcode electronic signature with GroupDocs.Signature: Advanced usage of eSearch Barcode signatures in a document and additional settings
See Also
- class SearchOptions
- namespace GroupDocs.Signature.Options
- assembly GroupDocs.Signature
