Leadtools.Barcode Namespace : IBarcodeReadOptions Interface |
public interface IBarcodeReadOptions : IBarcodeOptions
'Declaration Public Interface IBarcodeReadOptions Inherits IBarcodeOptions
'Usage Dim instance As IBarcodeReadOptions
public interface IBarcodeReadOptions : IBarcodeOptions
ObjectiveC Syntax
Java Syntax
function Leadtools.Barcode.IBarcodeReadOptions() IBarcodeOptions
public interface class IBarcodeReadOptions : public IBarcodeOptions
Note: In LEADTOOLS for .NET, the equivalent to this interface is the BarcodeReadOptions class.
The BarcodeReader class contains multiple methods to read a single or multiple barcodes from an image ( Refer to the BarcodeReader.ReadBarcode and BarcodeReader.ReadBarcodes methods). For each barcode found, BarcodeReader will return an instance of BarcodeData populated with the data found in the barcode.
The clases that implements IBarcodeReadOptions interface is used to control the options used when reading a barcode using LEADTOOLS. You can set the options in two ways:
The BarcodeReader class contains default options for each barcode symbology (or group of common symbologies). These options can be retrieved using the BarcodeReader.GetDefaultOptions method passing the symbology of interest. You can then change the members of the returned IBarcodeReadOptions (or after casting it to the appropriate derived class).
You can also create an instance of one of the derived IBarcodeReadOptions classes and use it directly in the BarcodeReader.ReadBarcode and BarcodeReader.ReadBarcodes methods that accepts a single or array of options as an input parameter.
The IBarcodeReadOptions contains the following members and features:
Member | Description |
---|---|
IBarcodeReadOptions.ForeColor |
Controls the barcode foreground color (color of the bars or symbols) to use when reading a barcode from a colored image. |
IBarcodeReadOptions.BackColor |
Controls the barcode background color (color of the spaces) to use when reading a barcode from a colored image. |
IBarcodeReadOptions is an interface and cannot be created directly, instead create one of these classes that implements it:
Read options class | Descriptions |
---|---|
OneDBarcodeReadOptions |
Standard 1D linear barcode options. Used when reading any of the following symbologies: EAN13, EAN8, UPCA, UPCE, Code3Of9, Code128, CodeInterleaved2Of5, Codabar, UCCEAN128, Code93, EANEXT5, EANEXT2, MSI, Code11, CodeStandard2Of5, GS1Databar, GS1DatabarLimited or GS1DatabarExpanded |
GS1DatabarStackedBarcodeReadOptions |
GS1 Databar stacked barcode options. Used when reading GS1DatabarStacked or GS1DatabarExpandedStacked symbologies |
FourStateBarcodeReadOptions |
4-State barcode options. Used when reading AustralianPost4State, RoyalMail4State or USPS4State symbologies |
PostNetPlanetBarcodeReadOptions |
POSTNET/Planet barcode options. Used when reading PostNet or Planet symbologies |
PatchCodeBarcodeReadOptions |
Patch code barcode options. Used when reading PatchCode symbology. |
DatamatrixBarcodeReadOptions |
Datamatrix barcode options. Used when reading Datamatrix symbology. |
MicroPDF417BarcodeReadOptions |
Micro PDF417 barcode options. Used when reading MicroPDF417 symbology. |
PDF417BarcodeReadOptions |
PDF417 barcode options. Used when reading PDF417 symbology. |
QRBarcodeReadOptions |
QR barcode options. Used when reading QR symbology. |
Public Sub BarcodeReadOptions_Example() Dim imageFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Barcode1.tif") ' Create a Barcode engine Dim engine As New BarcodeEngine() ' Get the Barcode reader instance Dim reader As BarcodeReader = engine.Reader ' Load the image Using codecs As New RasterCodecs() Using image As RasterImage = codecs.Load(imageFileName, 0, CodecsLoadByteOrder.BgrOrGray, 1, 1) ' Rotate the image by 90, so default option of reading horizonal barcodes will not work Console.WriteLine("Rotating the image by 90 degrees") Dim rotate As New RotateCommand(90 * 100, RotateCommandFlags.Resize, RasterColor.FromKnownColor(RasterKnownColor.White)) rotate.Run(image) ' Read all the barcodes from the image using default options Console.WriteLine("Reading barcodes using default options") Dim barcodes() As BarcodeData = reader.ReadBarcodes(image, LogicalRectangle.Empty, 0, Nothing, Nothing) ' Show the number of barcodes found, should be 0 since default search direction is horizontal Console.WriteLine("Found {0} barcodes", barcodes.Length) ' Now create options to read barcodes horizontally and vertically Dim options() As BarcodeReadOptions = GetHorizontalAndVerticalReadBarcodeOptions(reader) ' Read again Console.WriteLine("Reading barcodes using new options") barcodes = reader.ReadBarcodes(image, LogicalRectangle.Empty, 0, Nothing, options) ' Show the number of barcodes found, should all be read now Console.WriteLine("Found {0} barcodes", barcodes.Length) End Using End Using End Sub Private Shared Function GetHorizontalAndVerticalReadBarcodeOptions(ByVal reader As BarcodeReader) As BarcodeReadOptions() ' By default, the options read horizontal barcodes only, create an array of options capable of reading vertical barcodes ' Notice, we cloned the default options in reader so we will not change the original options Dim oneDReadOptions As OneDBarcodeReadOptions = DirectCast(reader.GetDefaultOptions(BarcodeSymbology.UPCA).Clone(), OneDBarcodeReadOptions) oneDReadOptions.SearchDirection = BarcodeSearchDirection.HorizontalAndVertical Dim fourStateReadOptions As FourStateBarcodeReadOptions = DirectCast(reader.GetDefaultOptions(BarcodeSymbology.USPS4State).Clone(), FourStateBarcodeReadOptions) fourStateReadOptions.SearchDirection = BarcodeSearchDirection.HorizontalAndVertical Dim postNetPlanetReadOptions As PostNetPlanetBarcodeReadOptions = DirectCast(reader.GetDefaultOptions(BarcodeSymbology.PostNet).Clone(), PostNetPlanetBarcodeReadOptions) postNetPlanetReadOptions.SearchDirection = BarcodeSearchDirection.HorizontalAndVertical Dim gs1StackedReadOptions As GS1DatabarStackedBarcodeReadOptions = DirectCast(reader.GetDefaultOptions(BarcodeSymbology.GS1DatabarStacked).Clone(), GS1DatabarStackedBarcodeReadOptions) gs1StackedReadOptions.SearchDirection = BarcodeSearchDirection.HorizontalAndVertical Dim patchCodeReadOptions As PatchCodeBarcodeReadOptions = DirectCast(reader.GetDefaultOptions(BarcodeSymbology.PatchCode).Clone(), PatchCodeBarcodeReadOptions) patchCodeReadOptions.SearchDirection = BarcodeSearchDirection.HorizontalAndVertical Dim pdf417ReadOptions As PDF417BarcodeReadOptions = DirectCast(reader.GetDefaultOptions(BarcodeSymbology.PDF417).Clone(), PDF417BarcodeReadOptions) pdf417ReadOptions.SearchDirection = BarcodeSearchDirection.HorizontalAndVertical Dim microPdf417ReadOptions As MicroPDF417BarcodeReadOptions = DirectCast(reader.GetDefaultOptions(BarcodeSymbology.MicroPDF417).Clone(), MicroPDF417BarcodeReadOptions) microPdf417ReadOptions.SearchDirection = BarcodeSearchDirection.HorizontalAndVertical ' Even though this array will not contain all options, it should be enough to read all barcodes, since the version of ReadBarcodes we will use ' will use the default options if an overriden is not passed Dim readOptions() As BarcodeReadOptions = _ { _ oneDReadOptions, fourStateReadOptions, postNetPlanetReadOptions, gs1StackedReadOptions, patchCodeReadOptions, pdf417ReadOptions, microPdf417ReadOptions _ } Return readOptions End Function Public NotInheritable Class LEAD_VARS Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" End Class
public void BarcodeReadOptions_Example() { string imageFileName = Path.Combine(LEAD_VARS.ImagesDir, "Barcode1.tif"); // Create a Barcode engine BarcodeEngine engine = new BarcodeEngine(); // Get the Barcode reader instance BarcodeReader reader = engine.Reader; // Load the image using(RasterCodecs codecs = new RasterCodecs()) { using(RasterImage image = codecs.Load(imageFileName, 0, CodecsLoadByteOrder.BgrOrGray, 1, 1)) { // Rotate the image by 90, so default option of reading horizonal barcodes will not work Console.WriteLine("Rotating the image by 90 degrees"); RotateCommand rotate = new RotateCommand(90 * 100, RotateCommandFlags.Resize, RasterColor.FromKnownColor(RasterKnownColor.White)); rotate.Run(image); // Read all the barcodes from the image using default options Console.WriteLine("Reading barcodes using default options"); BarcodeData[] barcodes = reader.ReadBarcodes(image, LogicalRectangle.Empty, 0, null, null); // Show the number of barcodes found, should be 0 since default search direction is horizontal Console.WriteLine("Found {0} barcodes", barcodes.Length); // Now create options to read barcodes horizontally and vertically BarcodeReadOptions[] options = GetHorizontalAndVerticalReadBarcodeOptions(reader); // Read again Console.WriteLine("Reading barcodes using new options"); barcodes = reader.ReadBarcodes(image, LogicalRectangle.Empty, 0, null, options); // Show the number of barcodes found, should all be read now Console.WriteLine("Found {0} barcodes", barcodes.Length); } } } private static BarcodeReadOptions[] GetHorizontalAndVerticalReadBarcodeOptions(BarcodeReader reader) { // By default, the options read horizontal barcodes only, create an array of options capable of reading vertical barcodes // Notice, we cloned the default options in reader so we will not change the original options OneDBarcodeReadOptions oneDReadOptions = reader.GetDefaultOptions(BarcodeSymbology.UPCA).Clone() as OneDBarcodeReadOptions; oneDReadOptions.SearchDirection = BarcodeSearchDirection.HorizontalAndVertical; FourStateBarcodeReadOptions fourStateReadOptions = reader.GetDefaultOptions(BarcodeSymbology.USPS4State).Clone() as FourStateBarcodeReadOptions; fourStateReadOptions.SearchDirection = BarcodeSearchDirection.HorizontalAndVertical; PostNetPlanetBarcodeReadOptions postNetPlanetReadOptions = reader.GetDefaultOptions(BarcodeSymbology.PostNet).Clone() as PostNetPlanetBarcodeReadOptions; postNetPlanetReadOptions.SearchDirection = BarcodeSearchDirection.HorizontalAndVertical; GS1DatabarStackedBarcodeReadOptions gs1StackedReadOptions = reader.GetDefaultOptions(BarcodeSymbology.GS1DatabarStacked).Clone() as GS1DatabarStackedBarcodeReadOptions; gs1StackedReadOptions.SearchDirection = BarcodeSearchDirection.HorizontalAndVertical; PatchCodeBarcodeReadOptions patchCodeReadOptions = reader.GetDefaultOptions(BarcodeSymbology.PatchCode).Clone() as PatchCodeBarcodeReadOptions; patchCodeReadOptions.SearchDirection = BarcodeSearchDirection.HorizontalAndVertical; PDF417BarcodeReadOptions pdf417ReadOptions = reader.GetDefaultOptions(BarcodeSymbology.PDF417).Clone() as PDF417BarcodeReadOptions; pdf417ReadOptions.SearchDirection = BarcodeSearchDirection.HorizontalAndVertical; MicroPDF417BarcodeReadOptions microPdf417ReadOptions = reader.GetDefaultOptions(BarcodeSymbology.MicroPDF417).Clone() as MicroPDF417BarcodeReadOptions; microPdf417ReadOptions.SearchDirection = BarcodeSearchDirection.HorizontalAndVertical; // Even though this array will not contain all options, it should be enough to read all barcodes, since the version of ReadBarcodes we will use // will use the default options if an override is not passed BarcodeReadOptions[] readOptions = { oneDReadOptions, fourStateReadOptions, postNetPlanetReadOptions, gs1StackedReadOptions, patchCodeReadOptions, pdf417ReadOptions, microPdf417ReadOptions }; return readOptions; } static class LEAD_VARS { public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images"; }
public void BarcodeReadOptions_Example(RasterImage image) { // Create a Barcode engine BarcodeEngine engine = new BarcodeEngine(); // Get the Barcode reader instance BarcodeReader reader = engine.Reader; // Load the image RasterCodecs codecs = new RasterCodecs(); // Rotate the image by 90, so default option of reading horizonal barcodes will not work Console.WriteLine("Rotating the image by 90 degrees"); RotateCommand rotate = new RotateCommand(90 * 100, RotateCommandFlags.Resize, RasterColor.FromKnownColor(RasterKnownColor.White)); rotate.Run(image); // Read all the barcodes from the image using default options Console.WriteLine("Reading barcodes using default options"); BarcodeData[] barcodes = reader.ReadBarcodes(image, LogicalRectangle.Empty, 0, null, null); // Show the number of barcodes found, should be 0 since default search direction is horizontal Console.WriteLine("Found {0} barcodes", barcodes.Length); // Now create options to read barcodes horizontally and vertically BarcodeReadOptions[] options = GetHorizontalAndVerticalReadBarcodeOptions(reader); // Read again Console.WriteLine("Reading barcodes using new options"); barcodes = reader.ReadBarcodes(image, LogicalRectangle.Empty, 0, null, options); // Show the number of barcodes found, should all be read now Console.WriteLine("Found {0} barcodes", barcodes.Length); } private static BarcodeReadOptions[] GetHorizontalAndVerticalReadBarcodeOptions(BarcodeReader reader) { // By default, the options read horizontal barcodes only, create an array of options capable of reading vertical barcodes // Notice, we cloned the default options in reader so we will not change the original options OneDBarcodeReadOptions oneDReadOptions = reader.GetDefaultOptions(BarcodeSymbology.UPCA).Clone() as OneDBarcodeReadOptions; oneDReadOptions.SearchDirection = BarcodeSearchDirection.HorizontalAndVertical; FourStateBarcodeReadOptions fourStateReadOptions = reader.GetDefaultOptions(BarcodeSymbology.USPS4State).Clone() as FourStateBarcodeReadOptions; fourStateReadOptions.SearchDirection = BarcodeSearchDirection.HorizontalAndVertical; PostNetPlanetBarcodeReadOptions postNetPlanetReadOptions = reader.GetDefaultOptions(BarcodeSymbology.PostNet).Clone() as PostNetPlanetBarcodeReadOptions; postNetPlanetReadOptions.SearchDirection = BarcodeSearchDirection.HorizontalAndVertical; GS1DatabarStackedBarcodeReadOptions gs1StackedReadOptions = reader.GetDefaultOptions(BarcodeSymbology.GS1DatabarStacked).Clone() as GS1DatabarStackedBarcodeReadOptions; gs1StackedReadOptions.SearchDirection = BarcodeSearchDirection.HorizontalAndVertical; PatchCodeBarcodeReadOptions patchCodeReadOptions = reader.GetDefaultOptions(BarcodeSymbology.PatchCode).Clone() as PatchCodeBarcodeReadOptions; patchCodeReadOptions.SearchDirection = BarcodeSearchDirection.HorizontalAndVertical; PDF417BarcodeReadOptions pdf417ReadOptions = reader.GetDefaultOptions(BarcodeSymbology.PDF417).Clone() as PDF417BarcodeReadOptions; pdf417ReadOptions.SearchDirection = BarcodeSearchDirection.HorizontalAndVertical; MicroPDF417BarcodeReadOptions microPdf417ReadOptions = reader.GetDefaultOptions(BarcodeSymbology.MicroPDF417).Clone() as MicroPDF417BarcodeReadOptions; microPdf417ReadOptions.SearchDirection = BarcodeSearchDirection.HorizontalAndVertical; // Even though this array will not contain all options, it should be enough to read all barcodes, since the version of ReadBarcodes we will use // will use the default options if an overriden is not passed BarcodeReadOptions[] readOptions = { oneDReadOptions, fourStateReadOptions, postNetPlanetReadOptions, gs1StackedReadOptions, patchCodeReadOptions, pdf417ReadOptions, microPdf417ReadOptions }; return readOptions; }
Public Sub BarcodeReadOptions_Example(ByVal image As RasterImage) ' Create a Barcode engine Dim engine As BarcodeEngine = New BarcodeEngine() ' Get the Barcode reader instance Dim reader As BarcodeReader = engine.Reader ' Load the image Dim codecs As RasterCodecs = New RasterCodecs() ' Rotate the image by 90, so default option of reading horizonal barcodes will not work Console.WriteLine("Rotating the image by 90 degrees") Dim rotate As RotateCommand = New RotateCommand(90 * 100, RotateCommandFlags.Resize, RasterColor.FromKnownColor(RasterKnownColor.White)) rotate.Run(image) ' Read all the barcodes from the image using default options Console.WriteLine("Reading barcodes using default options") Dim barcodes As BarcodeData() = reader.ReadBarcodes(image, LogicalRectangle.Empty, 0, Nothing, Nothing) ' Show the number of barcodes found, should be 0 since default search direction is horizontal Console.WriteLine("Found {0} barcodes", barcodes.Length) ' Now create options to read barcodes horizontally and vertically Dim options As BarcodeReadOptions() = GetHorizontalAndVerticalReadBarcodeOptions(reader) ' Read again Console.WriteLine("Reading barcodes using new options") barcodes = reader.ReadBarcodes(image, LogicalRectangle.Empty, 0, Nothing, options) ' Show the number of barcodes found, should all be read now Console.WriteLine("Found {0} barcodes", barcodes.Length) End Sub Private Shared Function GetHorizontalAndVerticalReadBarcodeOptions(ByVal reader As BarcodeReader) As BarcodeReadOptions() ' By default, the options read horizontal barcodes only, create an array of options capable of reading vertical barcodes ' Notice, we cloned the default options in reader so we will not change the original options Dim oneDReadOptions As OneDBarcodeReadOptions = TryCast(reader.GetDefaultOptions(BarcodeSymbology.UPCA).Clone(), OneDBarcodeReadOptions) oneDReadOptions.SearchDirection = BarcodeSearchDirection.HorizontalAndVertical Dim fourStateReadOptions As FourStateBarcodeReadOptions = TryCast(reader.GetDefaultOptions(BarcodeSymbology.USPS4State).Clone(), FourStateBarcodeReadOptions) fourStateReadOptions.SearchDirection = BarcodeSearchDirection.HorizontalAndVertical Dim postNetPlanetReadOptions As PostNetPlanetBarcodeReadOptions = TryCast(reader.GetDefaultOptions(BarcodeSymbology.PostNet).Clone(), PostNetPlanetBarcodeReadOptions) postNetPlanetReadOptions.SearchDirection = BarcodeSearchDirection.HorizontalAndVertical Dim gs1StackedReadOptions As GS1DatabarStackedBarcodeReadOptions = TryCast(reader.GetDefaultOptions(BarcodeSymbology.GS1DatabarStacked).Clone(), GS1DatabarStackedBarcodeReadOptions) gs1StackedReadOptions.SearchDirection = BarcodeSearchDirection.HorizontalAndVertical Dim patchCodeReadOptions As PatchCodeBarcodeReadOptions = TryCast(reader.GetDefaultOptions(BarcodeSymbology.PatchCode).Clone(), PatchCodeBarcodeReadOptions) patchCodeReadOptions.SearchDirection = BarcodeSearchDirection.HorizontalAndVertical Dim pdf417ReadOptions As PDF417BarcodeReadOptions = TryCast(reader.GetDefaultOptions(BarcodeSymbology.PDF417).Clone(), PDF417BarcodeReadOptions) pdf417ReadOptions.SearchDirection = BarcodeSearchDirection.HorizontalAndVertical Dim microPdf417ReadOptions As MicroPDF417BarcodeReadOptions = TryCast(reader.GetDefaultOptions(BarcodeSymbology.MicroPDF417).Clone(), MicroPDF417BarcodeReadOptions) microPdf417ReadOptions.SearchDirection = BarcodeSearchDirection.HorizontalAndVertical ' Even though this array will not contain all options, it should be enough to read all barcodes, since the version of ReadBarcodes we will use ' will use the default options if an overriden is not passed Dim readOptions As BarcodeReadOptions() = { oneDReadOptions, fourStateReadOptions, postNetPlanetReadOptions, gs1StackedReadOptions, patchCodeReadOptions, pdf417ReadOptions, microPdf417ReadOptions } Return readOptions End Function
Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
IBarcodeReadOptions Members
Leadtools.Barcode Namespace
OneDBarcodeReadOptions Class
GS1DatabarStackedBarcodeReadOptions Class
FourStateBarcodeReadOptions Class
PostNetPlanetBarcodeReadOptions Class
PatchCodeBarcodeReadOptions Class
DatamatrixBarcodeReadOptions Class
MicroPDF417BarcodeReadOptions Class
PDF417BarcodeReadOptions Class
QRBarcodeReadOptions Class
BarcodeReader Class
BarcodeSymbology Enumeration
BarcodeEngine Class
BarcodeReader.ReadBarcode
BarcodeReader.ReadBarcodes
Programming with LEADTOOLS Barcode
Supported Barcode Symbologies
Unlocking Barcode Support
Reading Barcodes Tutorial