Free Trial
Web API version
Licensing
Request A Quote
HAVE QUESTIONS OR NEED HELP? SUBMIT THE SUPPORT REQUEST FORM or write email to SUPPORT@BYTESCOUT.COM
Base interface for class that reads barcodes from images
Namespace: Bytescout.BarCodeReader
Assembly: Bytescout.BarCodeReader (in Bytescout.BarCodeReader.dll) Version: 12.0.1.2142-master
Syntax
The IReader type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | AllowOrphanedSupplementals |
Gets or sets a value indicating whether to allow orphaned
supplemental barcodes to be decoded.
|
 | BarcodeTypesToFind |
Gets or sets the barcode types to search for.
|
| ColorConversionMode |
Colors conversion mode. Default is ImageBlocks.
|
| Contrast |
Image contrast adjustment. Valid values from -100 to 100. Default is 0 (no adjustment).
|
| CustomArea |
Gets or sets custom scan area to find barcodes within.
|
| CustomAreaHeight |
Gets or sets height of custom scan area to find barcodes within.
|
| CustomAreaLeft |
Gets or sets leftmost position of custom scan area to find barcodes within.
|
| CustomAreaTop |
Gets or sets topmost position of custom scan area to find barcodes within.
|
| CustomAreaWidth |
Gets or sets width of custom scan area to find barcodes within.
|
| DecoderSpecificOptions |
Fine-tuning options for specific barcode decoders. May affect the decoding speed at the cost of reliability.
|
| DecodingTimeOut |
Timeout (in milliseconds) for the decoding process for one barcode type and per page.
Default is 0 (zero), disabled.
Set to timeout in milliseconds to check timeout time while decoding.
If decoding takes longer than timeout then the SDK aborts decoding and throws BarcodeReaderDecodingTimeoutException is thrown.
|
| FastMode |
Gets or set the "fast" mode for linear (1D) barcode types. Works faster but the recognition confidence is worse.
Use with barcode images of perfect quality.
|
| FoundBarcodes |
Gets the array of all barcodes found during last find.
|
| FoundCount |
Retrieves number of all barcodes found during last find.
|
| HeuristicMode |
Automatic analysis mode that tries to find fuzzy barcodes by variating internal parameters.
|
| ImagePreprocessingFilters |
Collection of image processing filters applied to image before the barcode decoding.
Allows to add multiple filters. Note, the order of adding does matter.
|
| LastDecodingTime |
Gets the time that last decoding process took.
|
| LastDecodingTimeOutExceeded |
This property indicates if last decoding timeout was exceeded (and the decoding was aborted)
so results may lack some barcodes.
To enable the timeout set DecodingTimeOut to non-zero value (in milliseconds).
|
| LicenseInfo |
Gets license information.
|
| MaxNumberOfBarcodesPerDocument |
Max number of barcodes to find in document. Default is 0 (unlimited number of barcodes).
|
| MaxNumberOfBarcodesPerPage |
Max number of barcodes to find on document page. Default is 0 (unlimited number of barcodes)
If you know number of barcodes on the page then you can set this number to save time and make reading faster.
|
| MediumTrustLevelCompatible |
Gets or sets a value indicating medium trust level compatibility.
|
| MinimalDataLength |
Gets or sets the minimal acceptable length of decoded data.
|
| NoiseRemovalFilterSize |
Block size of noise removal filter. Default is 1.
|
| NoiseRemovalFilterType |
Noise removal filter type, Blur or Median. Default is Blur.
|
| OptimizedProcessingOfLargeImages | Obsolete.
(!) Obsolete. Please use ImagePreprocessingFilters to add the scaling.
Get or set optimized processing of large images. Faster but may fail on some fuzzy barcodes.
|
| OptimizedProcessingOfLargeImagesSizeLimit | Obsolete.
(!) Obsolete. Please use ImagePreprocessingFilters to add the scaling.
Size limit for optimized processing of large images.
|
| Orientation |
Gets or sets the barcode orientations to search.
|
| PDFFontSmoothing |
Gets or sets whether the font smoothing in PDF is enabled. Default is true.
|
| PDFOptimizeSplittedParts |
Removes unused resources from splitted PDF document parts.
|
| PDFReadingMode |
Gets or sets the PDF reading mode:
PDFReadingMode.RenderPDF (0, default) - render whole page to image, then search for barcodes;
PDFReadingMode.ExtractEmbeddedImagesOnly - (1) - extract images, then search for barcodes.
|
| PDFRenderImages |
Gets or sets whether to render raster image objects in PDF documents. true by default.
|
| PDFRenderingResolution |
Gets or sets the PDF rendering resolution. Default is 200 DPI.
|
| PDFRenderText |
Gets or sets whether to render text objects (font-drawn objects) in PDF documents. true by default.
|
| PDFRenderVectors |
Gets or sets whether to render vector objects in PDF documents. true by default.
|
| Profiles |
Comma-separated list of profiles to apply to the Reader.
Profiles are sets of properties and methods represented as JSON string.
Check the source code examples installed with the SDK.
|
| RegistrationKey |
Gets or sets the key part of registration information.
|
| RegistrationName |
Gets or sets the name part of the registration information.
|
| RemoveNoize |
Removes noise from the image being processed.
Use this option with bad quality scanned images.
|
| RequireQuietZones |
Gets or sets a value indicating whether to require "quiet zones"
before and after barcode. "Quiet zone" is a whitespace with width
larger or equal to one symbol width.
|
| ScanArea |
Gets or sets the preset type of the scan area.
|
| ScanStep |
Scan interval for linear (1-dimensional) barcodes. Default is 1 (every bitmap row will be scanned).
|
| SearchNegative | Obsolete.
(!) Obsolete. Please use ImagePreprocessingFilters to add the negative filter.
Gets or sets a value indicating whether to search for negative barcodes.
|
| TextEncoding |
Text Encoding to decode barcode value. Set to System.Text.Encoding.Default by default (i.e. set to the default locale code page according to the Windows you run the SDK on).
You may override this value like:
reader.Encoding = System.Text.Encoding.GetEncoding(1250); // to use German locale to decode text
ActiveX interface: please use .TextEncodingCodePage property instead
|
| TextEncodingCodePage |
property for use via ActiveX interface: get or set CodePage to change code page to decode barcode text. This value is set to default code page value for this computer
You may override this value like:
reader.TextEncodingCodePage = 1250; // to use German locale to decode text
.NET interface: please use .TextEncoding property instead
Some of available code pages are listed below for your reference:
Name CodePage BodyName HeaderName WebName Encoding.EncodingName
shift_jis 932 iso-2022-jp iso-2022-jp shift_jis Japanese (Shift-JIS)
windows-1250 1250 iso-8859-2 windows-1250 windows-1250 Central European (Windows)
windows-1251 1251 koi8-r windows-1251 windows-1251 Cyrillic (Windows)
Windows-1252 1252 iso-8859-1 Windows-1252 Windows-1252 Western European (Windows)
windows-1253 1253 iso-8859-7 windows-1253 windows-1253 Greek (Windows)
windows-1254 1254 iso-8859-9 windows-1254 windows-1254 Turkish (Windows)
csISO2022JP 50221 iso-2022-jp iso-2022-jp csISO2022JP Japanese (JIS-Allow 1 byte Kana)
iso-2022-kr 50225 iso-2022-kr euc-kr iso-2022-kr Korean (ISO)
|
| TextEncodingUseUTF8 |
ActiveX interface: Enables UTF8 text encoding for use for barcode value decoding
.NET interface: Use .TextEncoding property and set it to System.Text.Encoding.UTF8 if you need to
|
| Version |
Gets the component version number.
|
Methods
| Name | Description | |
|---|---|---|
 | CreateProfile(String, Boolean, Boolean, Boolean) |
Creates JSON profile will all Reader properties with current values.
|
| CreateProfile(String, String, Boolean, Boolean, Boolean) |
Creates JSON profile will all Reader properties with current values.
|
| ExportFoundBarcodesToCSV |
Exports found barcodes to CSV format with default delimiter (,) and quotation (") symbols.
|
| ExportFoundBarcodesToCSV(String) |
Exports found barcodes to CSV file with default delimiter (,) and quotation (") symbols.
|
| ExportFoundBarcodesToCSV(String, String) |
Exports found barcodes to CSV format with specified delimiter and quotation symbols.
|
| ExportFoundBarcodesToCSV(String, String, String) |
Exports found barcodes to CSV file with specified delimiter and quotation symbols.
|
| ExportFoundBarcodesToCSV(String, String, String, Encoding) |
Exports found barcodes to CSV file with specified delimiter, quotation symbol, and character encoding.
|
| ExportFoundBarcodesToJSON |
Exports found barcodes to JSON string.
|
| ExportFoundBarcodesToJSON(String) |
Exports found barcodes to JSON file.
|
| ExportFoundBarcodesToTXT(Boolean) |
Save found barcodes in plain text format (TXT).
|
| ExportFoundBarcodesToTXT(String, Boolean, Encoding) |
Exports found barcodes to plain text file (TXT).
|
| ExportFoundBarcodesToXML |
Exports found barcodes to XML string.
|
| ExportFoundBarcodesToXML(String) |
Exports found barcodes to XML file.
|
| ExportFoundBarcodesToXMLDocument |
Exports found barcodes to XML document.
|
| ExtractPageFromDocument |
Extracts specified page from PDF or TIFF document to separate file.
|
| GetFoundBarcodeConfidence |
Gets the confidence level of the found barcode.
|
| GetFoundBarcodeHeight |
Gets the height of found barcode.
|
| GetFoundBarcodeLeft |
Gets the X coordinate of found barcode.
|
| GetFoundBarcodePage |
Gets the number of page where barcode was found.
|
| GetFoundBarcodeTop |
Gets the Y coordinate of found barcode.
|
| GetFoundBarcodeType |
Gets the type of the found barcode.
|
| GetFoundBarcodeValue |
Gets the found barcode value.
|
| GetFoundBarcodeWidth |
Gets the width of found barcode.
|
| GetImagePageCount(Image) |
Gets the number of pages in specified image.
|
| GetImagePageCount(String) |
Gets the number of pages in specified image file.
|
| GetPdfPageCount(Stream) |
Returns count of pages in PDF document.
|
| GetPdfPageCount(String) |
Returns count of pages in PDF document.
|
| LoadAndApplyProfiles |
Loads profiles from JSON string and automatically applies them.
IMPORTANT: you will need to select profile using .Profiles to apply it.
You can switch between profiles using .Profiles property to set profile name.
If you use simplified profiles format then default profile name is `profile1`
To apply mulitple profiles please use comma separated list, e.g.: `profile1, profile2`. Or `profile1` for one single profile.
|
| LoadProfiles |
Loads profiles from file. IMPORTANT: you will need to select profile using .Profiles to apply it.
You can switch between profiles using .Profiles property to set profile name.
If you use simplified profiles format then default profile name is `profile1`
To apply mulitple profiles please use comma separated list, e.g.: `profile1, profile2`. Or `profile1` for one single profile.
|
| LoadProfilesFromFileAndApply |
Loads profiles from file and applies immediately.
You can switch between profiles using .Profiles property to set profile name.
If you use simplified profiles format then default profile name is `profile1`
To apply mulitple profiles please use comma separated list, e.g.: `profile1, profile2`. Or `profile1` for one single profile.
|
| LoadProfilesFromString |
Loads profiles from JSON string. IMPORTANT: you will need to select profile using .Profiles to apply it.
You can switch between profiles using .Profiles property to set profile name.
If you use simplified profiles format then default profile name is `profile1`
To apply mulitple profiles please use comma separated list, e.g.: `profile1, profile2`. Or `profile1` for one single profile.
|
| ReadFrom(Bitmap) |
Reads barcodes from all pages of the Bitmap object.
|
| ReadFrom(String) |
Reads barcodes from all pages of the specified image or PDF file.
|
| ReadFrom(Bitmap, Int32) |
Reads barcodes from the specified page of the Bitmap object.
|
| ReadFrom(String, Int32) |
Reads barcodes from specified page of the specified image or PDF file.
|
| ReadFrom(Bitmap, Int32, Int32) |
Reads barcodes from the range of pages of the Bitmap object.
|
| ReadFrom(String, Int32, Int32) |
Reads barcodes from range of pages of the specified image or PDF file.
|
| ReadFromFile |
Reads barcodes from all pages of the specified image or PDF file. You can find decoded barcodes in FoundBarcodes property.
|
| ReadFromFilePage |
Reads barcodes from specified page of the image in the specified file.
You can find decoded barcodes in FoundBarcodes property.
|
| ReadFromHBitmap(IntPtr) |
Reads barcodes from the image specified by GDI HBITMAP handle.
You can find decoded barcodes in FoundBarcodes property.
|
| ReadFromHBitmap(IntPtr, Int32, Int32) |
Reads barcodes from the image specified by GDI HBITMAP handle. You can find decoded barcodes in FoundBarcodes property.
|
| ReadFromMemory(Byte) |
Read barcodes from image or PDF file provided as array of bytes.
You can find decoded barcodes in FoundBarcodes property.
|
| ReadFromMemory(Byte, Int32, Int32) |
Read barcodes from image or PDF file provided as array of bytes.
You can find decoded barcodes in FoundBarcodes property.
|
| ReadFromMemoryCOM(Object) |
COM/ActiveX: Read barcodes from image or PDF file provided as array of bytes represented by VARIANT values.
You can find decoded barcodes in FoundBarcodes property.
|
| ReadFromMemoryCOM(Object, Int32, Int32) |
COM/ActiveX: Read barcodes from image or PDF file provided as array of bytes represented by VARIANT values.
You can find decoded barcodes in FoundBarcodes property.
|
| ReadFromPdfFile(Stream) |
Reads barcodes from all pages of specified PDF document.
|
| ReadFromPdfFile(String) |
Reads barcodes from all pages of specified PDF document.
|
| ReadFromPdfFilePage(Stream, Int32, Int32) |
Reads barcodes from specified pages of PDF document.
|
| ReadFromPdfFilePage(String, Int32, Int32) |
Reads barcodes from specified pages of PDF document.
|
| ReadFromStream(Stream) |
Read barcodes from image or PDF file provided as Stream.
You can find decoded barcodes in FoundBarcodes property.
|
| ReadFromStream(IStream) |
Read barcodes from image or PDF file provided as IStream.
You can find decoded barcodes in FoundBarcodes property.
|
| ReadFromStream(Stream, Int32, Int32) |
Read barcodes from image or PDF file provided as Stream.
You can find decoded barcodes in FoundBarcodes property.
|
| ReadFromStream(IStream, Int32, Int32) |
Read barcodes from image or PDF file provided as IStream.
You can find decoded barcodes in FoundBarcodes property.
|
| SplitDocument(String, String) |
Splits PDF or TIFF document to multiple documents according to specified ranges.
|
| SplitDocument(String, String, String, Int32) |
Splits specified PDF or TIFF document to two documents at specified page.
|
| SplitDocumentCOM |
COM/ActiveX compatible function for Split(string sourceDocument, string ranges) that returns string with filenames delimited by line feed \n
Splits PDF or TIFF document to multiple documents according to specified ranges.
|
See Also