Search Results for

    Show / Hide Table of Contents

    Class BarcodeReader

    A versatile static class for reading many popular barcode formats from Images and PDFs.

    IronBarCode.BarcodeReader supports barcode reading from Bitmaps, Image Objects, Image Files, Image Streams, MultiFrame Tiff Images and also PDFs.

    Features: Crop-area support, Image filters, and preprocessing for improved accuracy including and the ability to automatically un-rotate, deskew and clean barcode image input.

    Inheritance
    System.Object
    BarcodeReader
    Namespace: IronBarCode
    Assembly: IronBarCode.dll
    Syntax
    public static class BarcodeReader : Object

    Methods

    Read(AnyBitmap, BarcodeReaderOptions)

    Reads all barcodes from an image with granular settings for developer control to balance performance against accuracy for their given use case.

    Overloads of this method accept InputImage as IronSoftware.Drawing.AnyBitmap as well as System.String file paths, array of System.Byte and System.IO.Stream types.

    Declaration
    public static BarcodeResults Read(AnyBitmap inputImage, BarcodeReaderOptions barcodeReaderOptions = null)
    Parameters
    Type Name Description
    IronSoftware.Drawing.AnyBitmap inputImage

    The input image as a IronSoftware.Drawing.AnyBitmap. Jpeg, Jpeg2000, Png, Bmp, Tiff & Gif Image formats are supported.

    BarcodeReaderOptions barcodeReaderOptions

    An Options class of BarcodeReader for reading many popular barcode formats from Images and PDFs in expected behavior.

    Returns
    Type Description
    BarcodeResults

    A BarcodeResults.

    Read(Byte[], BarcodeReaderOptions)

    Reads all barcodes from an image with granular settings for developer control to balance performance against accuracy for their given use case.

    Overloads of this method accept InputImage as array of System.Byte as well as IronSoftware.Drawing.AnyBitmap, string file paths and System.IO.Stream types.

    IEnumerable of Binary data of Image as a System.Byte array. Jpeg, Jpeg2000, Png, Bmp, Tiff & Gif Image formats are supported.An Options class of BarcodeReader for reading many popular barcode formats from Images and PDFs in expected behavior.A BarcodeResults.
    Declaration
    public static BarcodeResults Read(byte[] inputImage, BarcodeReaderOptions barcodeReaderOptions = null)
    Parameters
    Type Name Description
    System.Byte[] inputImage
    BarcodeReaderOptions barcodeReaderOptions
    Returns
    Type Description
    BarcodeResults

    Read(IEnumerable<AnyBitmap>, BarcodeReaderOptions)

    Reads barcodes from multiple images.

    Reading in parallel should set by BarcodeReaderOptions.Multithreaded = true and multiple threads will automatically be started and managed to improve performance for batch barcode reading tasks.

    Features granular settings for developer control to balance performance against accuracy for their given use case.

    Overloads of this method accept InputImage as IEnumerable of System.String file paths as well as IronSoftware.Drawing.AnyBitmap, array of System.Byte and System.IO.Stream types.

    Declaration
    public static BarcodeResults Read(IEnumerable<AnyBitmap> inputImages, BarcodeReaderOptions barcodeReaderOptions = null)
    Parameters
    Type Name Description
    System.Collections.Generic.IEnumerable<IronSoftware.Drawing.AnyBitmap> inputImages

    The input images as an IEnumerable of IronSoftware.Drawing.AnyBitmap. Jpeg, Jpeg2000, Png, Bmp, Tiff & Gif Image formats are supported.

    BarcodeReaderOptions barcodeReaderOptions

    An Options class of BarcodeReader for reading many popular barcode formats from Images and PDFs in expected behavior.

    Returns
    Type Description
    BarcodeResults

    An Array of BarcodeResults. Array length will be zero if no barcodes were found.

    Read(IEnumerable<Byte[]>, BarcodeReaderOptions)

    Reads barcodes from multiple images.

    Reading in parallel should set by BarcodeReaderOptions.Multithreaded = true and multiple threads will automatically be started and managed to improve performance for batch barcode reading tasks.

    Overloads of this method accept InputImage as IEnumerable of array of System.Byte as well as IronSoftware.Drawing.AnyBitmap, string file paths and System.IO.Stream types.

    IEnumerable of Binary data of Image as a System.Byte array. Jpeg, Jpeg2000, Png, Bmp, Tiff & Gif Image formats are supported.An Options class of BarcodeReader for reading many popular barcode formats from Images and PDFs in expected behavior. A BarcodeResults.
    Declaration
    public static BarcodeResults Read(IEnumerable<byte[]> inputImage, BarcodeReaderOptions barcodeReaderOptions = null)
    Parameters
    Type Name Description
    System.Collections.Generic.IEnumerable<System.Byte[]> inputImage
    BarcodeReaderOptions barcodeReaderOptions
    Returns
    Type Description
    BarcodeResults

    Read(IEnumerable<Stream>, BarcodeReaderOptions)

    Reads barcodes from multiple images.

    Reading in parallel should set by BarcodeReaderOptions.Multithreaded = true and multiple threads will automatically be started and managed to improve performance for batch barcode reading tasks.

    Features granular settings for developer control to balance performance against accuracy for their given use case.

    Overloads of this method accept InputImage as IEnumerable of System.IO.Stream as well as IronSoftware.Drawing.AnyBitmap, array of System.Byte and System.String file paths types.

    Declaration
    public static BarcodeResults Read(IEnumerable<Stream> inputImages, BarcodeReaderOptions barcodeReaderOptions = null)
    Parameters
    Type Name Description
    System.Collections.Generic.IEnumerable<System.IO.Stream> inputImages

    The input images as an IEnumerable of System.IO.Stream. Jpeg, Jpeg2000, Png, Bmp, Tiff & Gif Image formats are supported.

    BarcodeReaderOptions barcodeReaderOptions

    An Options class of BarcodeReader for reading many popular barcode formats from Images and PDFs in expected behavior.

    Returns
    Type Description
    BarcodeResults

    A BarcodeResults.

    Read(IEnumerable<String>, BarcodeReaderOptions)

    Reads barcodes from multiple images.

    Reading in parallel should set by BarcodeReaderOptions.Multithreaded = true and multiple threads will automatically be started and managed to improve performance for batch barcode reading tasks.

    Features granular settings for developer control to balance performance against accuracy for their given use case.

    Overloads of this method accept InputImage as IEnumerable of System.String file paths as well as IronSoftware.Drawing.AnyBitmap, array of System.Byte and System.IO.Stream types.

    Declaration
    public static BarcodeResults Read(IEnumerable<string> inputImages, BarcodeReaderOptions barcodeReaderOptions = null)
    Parameters
    Type Name Description
    System.Collections.Generic.IEnumerable<System.String> inputImages

    The input images as an IEnumerable of string file paths. Jpeg, Jpeg2000, Png, Bmp, Tiff & Gif Image formats are supported.

    BarcodeReaderOptions barcodeReaderOptions

    An Options class of BarcodeReader for reading many popular barcode formats from Images and PDFs in expected behavior.

    Returns
    Type Description
    BarcodeResults

    A BarcodeResults.

    Read(Stream, BarcodeReaderOptions)

    Reads all barcodes from an image with granular settings for developer control to balance performance against accuracy for their given use case.

    Overloads of this method accept InputImage as System.IO.Stream as well as IronSoftware.Drawing.AnyBitmap, array of System.Byte and System.String file paths types.

    Declaration
    public static BarcodeResults Read(Stream inputImage, BarcodeReaderOptions barcodeReaderOptions = null)
    Parameters
    Type Name Description
    System.IO.Stream inputImage

    The input image as a System.IO.Stream. Jpeg, Jpeg2000, Png, Bmp, Tiff & Gif Image formats are supported.

    BarcodeReaderOptions barcodeReaderOptions

    An Options class of BarcodeReader for reading many popular barcode formats from Images and PDFs in expected behavior.

    Returns
    Type Description
    BarcodeResults

    A BarcodeResults.

    Read(String, BarcodeReaderOptions)

    Reads all barcodes from an image with granular settings for developer control to balance performance against accuracy for their given use case.

    Overloads of this method accept InputImage as System.String file paths as well as IronSoftware.Drawing.AnyBitmap, array of System.Byte and System.IO.Stream types.

    Declaration
    public static BarcodeResults Read(string inputImage, BarcodeReaderOptions barcodeReaderOptions = null)
    Parameters
    Type Name Description
    System.String inputImage

    The input image as a System.String file path to an image or PDF. Jpeg, Jpeg2000, Png, Bmp, Tiff & Gif Image formats are supported.

    BarcodeReaderOptions barcodeReaderOptions

    An Options class of BarcodeReader for reading many popular barcode formats from Images and PDFs in expected behavior.

    Returns
    Type Description
    BarcodeResults

    A BarcodeResults.

    ReadAsync(AnyBitmap, BarcodeReaderOptions)

    Reads a barcode from an image.

    Features granular settings for developer control to balance performance against accuracy for their given use case.

    Declaration
    public static Task<BarcodeResults> ReadAsync(AnyBitmap inputImage, BarcodeReaderOptions barcodeReaderOptions = null)
    Parameters
    Type Name Description
    IronSoftware.Drawing.AnyBitmap inputImage

    The input image as an IronSoftware.Drawing.AnyBitmap. Jpeg, Jpeg2000, Png, Bmp, Tiff & Gif Image formats are supported.

    BarcodeReaderOptions barcodeReaderOptions

    An Options class of BarcodeReader for reading many popular barcode formats from Images and PDFs in expected behavior.

    Returns
    Type Description
    System.Threading.Tasks.Task<BarcodeResults>

    A BarcodeResults.

    ReadAsync(Byte[], BarcodeReaderOptions)

    Reads barcode from an image

    Features granular settings for developer control to balance performance against accuracy for their given use case.

    Binary data of Image as a System.Byte array. Jpeg, Jpeg2000, Png, Bmp, Tiff & Gif Image formats are supported..An Options class of BarcodeReader for reading many popular barcode formats from Images and PDFs in expected behavior. A BarcodeResults.
    Declaration
    public static Task<BarcodeResults> ReadAsync(byte[] inputImage, BarcodeReaderOptions barcodeReaderOptions = null)
    Parameters
    Type Name Description
    System.Byte[] inputImage
    BarcodeReaderOptions barcodeReaderOptions
    Returns
    Type Description
    System.Threading.Tasks.Task<BarcodeResults>

    ReadAsync(IEnumerable<AnyBitmap>, BarcodeReaderOptions)

    Reads barcodes from multiple images in parallel. Multiple threads will automatically be started and managed to improve performance for batch barcode reading tasks.

    Features granular settings for developer control to balance performance against accuracy for their given use case.

    Declaration
    public static Task<BarcodeResults> ReadAsync(IEnumerable<AnyBitmap> inputImages, BarcodeReaderOptions barcodeReaderOptions = null)
    Parameters
    Type Name Description
    System.Collections.Generic.IEnumerable<IronSoftware.Drawing.AnyBitmap> inputImages

    The input images as an IEnumerable of IronSoftware.Drawing.AnyBitmap. Jpeg, Jpeg2000, Png, Bmp, Tiff & Gif Image formats are supported.

    BarcodeReaderOptions barcodeReaderOptions

    An Options class of BarcodeReader for reading many popular barcode formats from Images and PDFs in expected behavior.

    Returns
    Type Description
    System.Threading.Tasks.Task<BarcodeResults>

    A BarcodeResults.

    ReadAsync(IEnumerable<Byte[]>, BarcodeReaderOptions)

    Reads barcodes from multiple images in parallel. Multiple threads will automatically be started and managed to improve performance for batch barcode reading tasks.

    Features granular settings for developer control to balance performance against accuracy for their given use case.

    Overloads of this method accept InputImage as IEnumerable of array of System.Byte as well as IronSoftware.Drawing.AnyBitmap, string file paths and System.IO.Stream types.

    IEnumerable of Binary data of Image as a System.Byte array. Jpeg, Jpeg2000, Png, Bmp, Tiff & Gif Image formats are supported..An Options class of BarcodeReader for reading many popular barcode formats from Images and PDFs in expected behavior. A BarcodeResults.
    Declaration
    public static Task<BarcodeResults> ReadAsync(IEnumerable<byte[]> inputImages, BarcodeReaderOptions barcodeReaderOptions = null)
    Parameters
    Type Name Description
    System.Collections.Generic.IEnumerable<System.Byte[]> inputImages
    BarcodeReaderOptions barcodeReaderOptions
    Returns
    Type Description
    System.Threading.Tasks.Task<BarcodeResults>

    ReadAsync(IEnumerable<Stream>, BarcodeReaderOptions)

    Reads barcodes from multiple images in parallel. Multiple threads will automatically be started and managed to improve performance for batch barcode reading tasks.

    Features granular settings for developer control to balance performance against accuracy for their given use case.

    Overloads of this method accept InputImage as IEnumerable of System.IO.Stream as well as IronSoftware.Drawing.AnyBitmap , array of System.Byte and System.String file paths types.

    Declaration
    public static Task<BarcodeResults> ReadAsync(IEnumerable<Stream> inputImages, BarcodeReaderOptions barcodeReaderOptions = null)
    Parameters
    Type Name Description
    System.Collections.Generic.IEnumerable<System.IO.Stream> inputImages

    The input images as an IEnumerable of System.IO.Stream. Jpeg, Jpeg2000, Png, Bmp, Tiff & Gif Image formats are supported.

    BarcodeReaderOptions barcodeReaderOptions

    An Options class of BarcodeReader for reading many popular barcode formats from Images and PDFs in expected behavior.

    Returns
    Type Description
    System.Threading.Tasks.Task<BarcodeResults>

    A BarcodeResults.

    ReadAsync(IEnumerable<String>, BarcodeReaderOptions)

    Reads barcodes from multiple images in parallel. Multiple threads will automatically be started and managed to improve performance for batch barcode reading tasks.

    Features granular settings for developer control to balance performance against accuracy for their given use case.

    Overloads of this method accept InputImage as IEnumerable of System.String file paths as well as IronSoftware.Drawing.AnyBitmap , array of System.Byte and System.IO.Stream types.

    Declaration
    public static Task<BarcodeResults> ReadAsync(IEnumerable<string> inputImages, BarcodeReaderOptions barcodeReaderOptions = null)
    Parameters
    Type Name Description
    System.Collections.Generic.IEnumerable<System.String> inputImages

    The input images as an IEnumerable of System.String file paths. Jpeg, Jpeg2000, Png, Bmp, Tiff & Gif Image formats are supported.

    BarcodeReaderOptions barcodeReaderOptions

    An Options class of BarcodeReader for reading many popular barcode formats from Images and PDFs in expected behavior.

    Returns
    Type Description
    System.Threading.Tasks.Task<BarcodeResults>

    A BarcodeResults.

    ReadAsync(Stream, BarcodeReaderOptions)

    Reads barcode from an image

    Features granular settings for developer control to balance performance against accuracy for their given use case.

    Declaration
    public static Task<BarcodeResults> ReadAsync(Stream inputImage, BarcodeReaderOptions barcodeReaderOptions = null)
    Parameters
    Type Name Description
    System.IO.Stream inputImage

    The input image as a System.IO.Stream. Jpeg, Jpeg2000, Png, Bmp, Tiff & Gif Image formats are supported.

    BarcodeReaderOptions barcodeReaderOptions

    An Options class of BarcodeReader for reading many popular barcode formats from Images and PDFs in expected behavior.

    Returns
    Type Description
    System.Threading.Tasks.Task<BarcodeResults>

    A BarcodeResults.

    ReadAsync(String, BarcodeReaderOptions)

    Reads a barcode from an image

    Features granular settings for developer control to balance performance against accuracy for their given use case.

    Declaration
    public static Task<BarcodeResults> ReadAsync(string inputImage, BarcodeReaderOptions barcodeReaderOptions = null)
    Parameters
    Type Name Description
    System.String inputImage

    The input image file paths. Jpeg, Jpeg2000, Png, Bmp, Tiff & Gif Image formats are supported.

    BarcodeReaderOptions barcodeReaderOptions

    An Options class of BarcodeReader for reading many popular barcode formats from Images and PDFs in expected behavior.

    Returns
    Type Description
    System.Threading.Tasks.Task<BarcodeResults>

    A BarcodeResults.

    ReadPdf(Byte[], PdfBarcodeReaderOptions)

    Reads barcodes from every image embedded in every page of a PDF document.

    Features granular settings for developer control to balance performance against accuracy for their given use case.

    Overloads of this method accept PdfData as array of System.Byte as well as System.String and System.IO.Stream types.

    Declaration
    public static BarcodeResults ReadPdf(byte[] pdfData, PdfBarcodeReaderOptions pdfBarcodeReaderOptions = null)
    Parameters
    Type Name Description
    System.Byte[] pdfData

    Binary data of PDF document as a System.Byte array.

    PdfBarcodeReaderOptions pdfBarcodeReaderOptions

    An Options class of PdfBarcodeReader for reading barcode from pdf.

    Returns
    Type Description
    BarcodeResults

    A BarcodeResults.

    ReadPdf(IEnumerable<Byte[]>, PdfBarcodeReaderOptions)

    Reads barcodes from every image embedded in every page of a PDF document.

    Features granular settings for developer control to balance performance against accuracy for their given use case.

    Overloads of this method accept PdfData as IEnumerable of array of System.Byte as well as System.String and System.IO.Stream types.

    An enumerable of Binary data of PDF document as a System.Byte array.An Options class of PdfBarcodeReader for reading barcode from pdf. A BarcodeResults.
    Declaration
    public static BarcodeResults ReadPdf(IEnumerable<byte[]> pdfData, PdfBarcodeReaderOptions pdfBarcodeReaderOptions = null)
    Parameters
    Type Name Description
    System.Collections.Generic.IEnumerable<System.Byte[]> pdfData
    PdfBarcodeReaderOptions pdfBarcodeReaderOptions
    Returns
    Type Description
    BarcodeResults

    ReadPdf(IEnumerable<Stream>, PdfBarcodeReaderOptions)

    Reads barcodes from every image embedded in every page of a PDF document.

    Features granular settings for developer control to balance performance against accuracy for their given use case.

    Overloads of this method accept PdfData as IEnumerable of System.IO.Stream as well as array of System.Byte and System.String file paths types.

    An enumerable of Binary data of PDF document as a System.IO.Stream.An Options class of PdfBarcodeReader for reading barcode from pdf. A BarcodeResults.
    Declaration
    public static BarcodeResults ReadPdf(IEnumerable<Stream> pdfStreams, PdfBarcodeReaderOptions pdfBarcodeReaderOptions = null)
    Parameters
    Type Name Description
    System.Collections.Generic.IEnumerable<System.IO.Stream> pdfStreams
    PdfBarcodeReaderOptions pdfBarcodeReaderOptions
    Returns
    Type Description
    BarcodeResults

    ReadPdf(IEnumerable<String>, PdfBarcodeReaderOptions)

    Reads barcodes from every image embedded in every page of a PDF document.

    Features granular settings for developer control to balance performance against accuracy for their given use case.

    Overloads of this method accept PdfData as IEnumerable of System.String file paths as well as array of System.Byte and System.IO.Stream types.

    An enumerable of System.String file path to a PDF document.An Options class of PdfBarcodeReader for reading barcode from pdf. A BarcodeResults.
    Declaration
    public static BarcodeResults ReadPdf(IEnumerable<string> pdfPaths, PdfBarcodeReaderOptions pdfBarcodeReaderOptions = null)
    Parameters
    Type Name Description
    System.Collections.Generic.IEnumerable<System.String> pdfPaths
    PdfBarcodeReaderOptions pdfBarcodeReaderOptions
    Returns
    Type Description
    BarcodeResults

    ReadPdf(Stream, PdfBarcodeReaderOptions)

    Reads barcodes from every image embedded in every page of a PDF document.

    Features granular settings for developer control to balance performance against accuracy for their given use case.

    Overloads of this method accept PdfData as System.IO.Stream as well as array of System.Byte and System.String file paths types.

    Declaration
    public static BarcodeResults ReadPdf(Stream pdfStream, PdfBarcodeReaderOptions pdfBarcodeReaderOptions = null)
    Parameters
    Type Name Description
    System.IO.Stream pdfStream

    Binary data of PDF document as a System.IO.Stream.

    PdfBarcodeReaderOptions pdfBarcodeReaderOptions

    An Options class of PdfBarcodeReader for reading barcode from pdf.

    Returns
    Type Description
    BarcodeResults

    A BarcodeResults.

    ReadPdf(String, PdfBarcodeReaderOptions)

    Reads barcodes from every image embedded in every page of a PDF document.

    Features granular settings for developer control to balance performance against accuracy for their given use case.

    Overloads of this method accept PdfData as System.String file paths as well as array of System.Byte and System.IO.Stream types.

    Declaration
    public static BarcodeResults ReadPdf(string pdfPath, PdfBarcodeReaderOptions pdfBarcodeReaderOptions = null)
    Parameters
    Type Name Description
    System.String pdfPath

    System.String file path to a PDF document.

    PdfBarcodeReaderOptions pdfBarcodeReaderOptions

    An Options class of PdfBarcodeReader for reading barcode from pdf.

    Returns
    Type Description
    BarcodeResults

    A BarcodeResults.

    ReadPdfAsync(IEnumerable<Byte[]>, PdfBarcodeReaderOptions)

    Reads barcodes from every image embedded in every page of a PDF document.

    Features granular settings for developer control to balance performance against accuracy for their given use case.

    Overloads of this method accept PdfData as IEnumerable of array of System.Byte as well as System.String and System.IO.Stream types.

    An enumerable of Binary data of PDF document as a System.Byte array.An Options class of PdfBarcodeReader for reading barcode from pdf. A BarcodeResults.
    Declaration
    public static Task<BarcodeResults> ReadPdfAsync(IEnumerable<byte[]> pdfData, PdfBarcodeReaderOptions pdfBarcodeReaderOptions = null)
    Parameters
    Type Name Description
    System.Collections.Generic.IEnumerable<System.Byte[]> pdfData
    PdfBarcodeReaderOptions pdfBarcodeReaderOptions
    Returns
    Type Description
    System.Threading.Tasks.Task<BarcodeResults>

    ReadPdfAsync(IEnumerable<Stream>, PdfBarcodeReaderOptions)

    Reads barcodes from every image embedded in every page of a PDF document.

    Features granular settings for developer control to balance performance against accuracy for their given use case.

    Overloads of this method accept PdfData as IEnumerable of System.IO.Stream as well as array of System.Byte and System.String file paths types.

    An enumerable of Binary data of PDF document as a System.IO.Stream.An Options class of PdfBarcodeReader for reading barcode from pdf. A BarcodeResults.
    Declaration
    public static Task<BarcodeResults> ReadPdfAsync(IEnumerable<Stream> pdfStreams, PdfBarcodeReaderOptions pdfBarcodeReaderOptions = null)
    Parameters
    Type Name Description
    System.Collections.Generic.IEnumerable<System.IO.Stream> pdfStreams
    PdfBarcodeReaderOptions pdfBarcodeReaderOptions
    Returns
    Type Description
    System.Threading.Tasks.Task<BarcodeResults>

    ReadPdfAsync(IEnumerable<String>, PdfBarcodeReaderOptions)

    Reads barcodes from every image embedded in every page of a PDF document.

    Features granular settings for developer control to balance performance against accuracy for their given use case.

    Overloads of this method accept PdfData as IEnumerable of System.String file paths as well as array of System.Byte and System.IO.Stream types.

    An enumerable of string file path to a PDF document.An Options class of PdfBarcodeReader for reading barcode from pdf. A BarcodeResults.
    Declaration
    public static Task<BarcodeResults> ReadPdfAsync(IEnumerable<string> pdfPaths, PdfBarcodeReaderOptions pdfBarcodeReaderOptions = null)
    Parameters
    Type Name Description
    System.Collections.Generic.IEnumerable<System.String> pdfPaths
    PdfBarcodeReaderOptions pdfBarcodeReaderOptions
    Returns
    Type Description
    System.Threading.Tasks.Task<BarcodeResults>
    ☀
    ☾
    Downloads
    • Download with Nuget
    • Start for Free
    In This Article
    Back to top
    Install with Nuget
    Want to deploy IronBarcode to a live project for FREE?
    What’s included?
    30 days of fully-functional product
    Test and share in a live environment
    No watermarks in production
    Get your free 30-day Trial Key instantly.
    No credit card or account creation required
    Your Trial License Key has been emailed to you.
    Download IronBarcode free to apply
    your Trial Licenses Key
    Install with NuGet View Licenses
    Licenses from $499. Have a question? Get in touch.