DocumentBarcodes Class

Summary

Manages the global barcodes settings for the document.

Syntax

C++

Java

[DataContractAttribute()] 
public class DocumentBarcodes

<DataContractAttribute()>  
Public Class DocumentBarcodes

public [DataContractAttribute] 
   ref class DocumentBarcodes

public class DocumentBarcodes implements Serializable

Remarks

DocumentBarcodes manages the global barcodes settings of the document. It can be accessed through the Barcodes property of LEADDocument.

DocumentBarcodes contains the following:

BarcodeEngine: The engine to use when reading barcdoes.

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

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Document.Writer; 
using Leadtools.Svg; 
using LeadtoolsExamples.Common; 
using Leadtools.Document; 
using Leadtools.Caching; 
using Leadtools.Annotations.Engine; 
using Leadtools.Ocr; 
using Leadtools.Barcode; 
using Leadtools.Document.Converter; 
 
private static void DocumentBarcodesExample() 
{ 
   var options = new LoadDocumentOptions(); 
   // Create a document from the barcode sample image shipping with LEADTOOLS 
   using (var document = DocumentFactory.LoadFromFile(Path.Combine(ImagesPath.Path, "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 
      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); 
   } 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.Document.Writer 
Imports Leadtools.Svg 
Imports Leadtools.Document 
Imports Leadtools.Caching 
Imports Leadtools.Annotations.Engine 
Imports Leadtools.Barcode 
Imports Leadtools.Ocr 
Imports LeadtoolsDocumentExamples.LeadtoolsExamples.Common 
Imports Leadtools.Document.Converter 
 
Private Shared Sub DocumentBarcodesExample() 
   Dim options As New LoadDocumentOptions() 
   ' Create a document from the barcode sample image shipping with LEADTOOLS 
   Using document As LEADDocument = DocumentFactory.LoadFromFile(Path.Combine(ImagesPath.Path, "Barcode1.tif"), options) 
      ' Setup a barcode reader object 
      Dim barcodeEngine As 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 
      document.Barcodes.BarcodeEngine = barcodeEngine 
 
      ' Read all the barcodes in the first page 
      Dim page As Leadtools.Document.DocumentPage = document.Pages(0) 
      Dim barcodes() As BarcodeData = page.ReadBarcodes(LeadRectD.Empty, 0, Nothing) 
      Console.WriteLine("{0} barcode(s) found.", barcodes.Length) 
      For Each barcode As BarcodeData In barcodes 
         Console.WriteLine(" type {0} data {1}", barcode.Symbology, barcode.Value) 
      Next 
   End Using 
End Sub

Requirements

Target Platforms

Reference

DocumentBarcodes Members

Leadtools.Document Namespace

Download our FREE evaluation

Help Version 20.0.2020.4.3

Leadtools.Document Assembly

Introduction

Getting Started

Namespaces

Leadtools.Document Namespace

Assemblies