BarcodeEngine Property

Summary

Engine instance to use when reading barcodes.

Syntax

C++/CLI

Java

Python

public BarcodeEngine BarcodeEngine { get; set; }

public:  
   property BarcodeEngine^ BarcodeEngine 
   { 
      BarcodeEngine^ get() 
      void set(BarcodeEngine^ value) 
   }

public BarcodeEngine getBarcodeEngine() 
public void setBarcodeEngine(BarcodeEngine value)

BarcodeEngine # get and set (DocumentBarcodes)

Property Value

The engine instance to use when reading barcodes. Default value is null.

Remarks

The DocumentPage.ReadBarcodes method is used to read the barcodes of a page. The document will check if the value in BarcodeEngine is not null, if so, it will try to read the barcodes based on options set in BarcodeReader.

For more information, refer to Barcode processing with the Document Library.

Example

Java

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Document.Writer; 
 
using Leadtools.Document; 
using Leadtools.Caching; 
using Leadtools.Annotations.Engine; 
using Leadtools.Ocr; 
using Leadtools.Barcode; 
using Leadtools.Document.Converter; 
 
public void DocumentBarcodesExample() 
{ 
   var options = new LoadDocumentOptions(); 
   // Create a document from the barcode sample image shipping with LEADTOOLS 
   using (var document = DocumentFactory.LoadFromFile(Path.Combine(LEAD_VARS.ImagesDir, "Barcode1.tif"), options)) 
   { 
      // Setup a barcode reader object 
      var barcodeEngine = new BarcodeEngine(); 
      // Optionally, setup the reader option. Here we instruct the barcode reader to read all types of barcodes 
      barcodeEngine.Reader.ImageType = BarcodeImageType.Unknown; 
      // Set this engine to be used with the document 
      // DocumentBarcodes reference 
      document.Barcodes.BarcodeEngine = barcodeEngine; 
 
      // Read all the barcodes in the first page 
      var page = document.Pages[0]; 
      var barcodes = page.ReadBarcodes(LeadRectD.Empty, 0, null); 
      Console.WriteLine("{0} barcode(s) found.", barcodes.Length); 
      foreach (var barcode in barcodes) 
         Console.WriteLine(" type {0} data {1}", barcode.Symbology, barcode.Value); 
   } 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS23\Resources\Images"; 
}

 
import java.io.File; 
import java.io.FileOutputStream; 
import java.io.IOException; 
import java.net.MalformedURLException; 
import java.net.URI; 
import java.net.URISyntaxException; 
import java.net.URL; 
import java.nio.file.Files; 
import java.nio.file.Paths; 
import java.util.ArrayList; 
import java.util.Calendar; 
import java.util.List; 
import java.util.concurrent.Callable; 
import java.util.concurrent.ExecutorService; 
import java.util.concurrent.Executors; 
import java.util.concurrent.Future; 
import java.util.regex.Pattern; 
 
import org.junit.*; 
import org.junit.runner.JUnitCore; 
import org.junit.runner.Result; 
import org.junit.runner.notification.Failure; 
import static org.junit.Assert.*; 
 
import leadtools.*; 
import leadtools.annotations.engine.*; 
import leadtools.barcode.*; 
import leadtools.caching.*; 
import leadtools.codecs.*; 
import leadtools.document.*; 
import leadtools.document.DocumentMimeTypes.UserGetDocumentStatusHandler; 
import leadtools.document.converter.*; 
import leadtools.document.writer.*; 
import leadtools.ocr.*; 
 
 
public void documentBarcodesExample() { 
   final String LEAD_VARS_IMAGES_DIR = "C:\\LEADTOOLS23\\Resources\\Images"; 
   LoadDocumentOptions options = new LoadDocumentOptions(); 
   // Create a document from the barcode sample image shipping with LEADTOOLS 
   LEADDocument document = DocumentFactory.loadFromFile(combine(LEAD_VARS_IMAGES_DIR, "Barcode1.tif"), options); 
   // Setup a barcode reader object 
   BarcodeEngine barcodeEngine = new BarcodeEngine(); 
   // Optionally, setup the reader option. Here we instruct the barcode reader to 
   // read all types of barcodes 
   barcodeEngine.getReader().setImageType(BarcodeImageType.UNKNOWN); 
   // Set this engine to be used with the document 
   // DocumentBarcodes reference 
   document.getBarcodes().setBarcodeEngine(barcodeEngine); 
 
   // Read all the barcodes in the first page 
   DocumentPage page = document.getPages().get(0); 
   BarcodeData[] barcodes = page.readBarcodes(LeadRectD.getEmpty(), 0, null); 
   System.out.println(barcodes.length + " barcode(s) found."); 
   for (BarcodeData barcode : barcodes) { 
      System.out.printf(" type %s data %s%n", barcode.getSymbology(), barcode.getValue()); 
   } 
   assertTrue(barcodes.length > 0); 
}

Requirements

Target Platforms

Reference

DocumentBarcodes Class

DocumentBarcodes Members

Leadtools.Document Namespace

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Document Assembly

Introduction

Getting Started

Namespaces

Leadtools.Document Namespace

Assemblies