MaxiBarcodeWriteOptions Class

Summary

Contains the extra options to use when writing MaxiCode barcodes.

Syntax

Objective-C

C++/CLI

Java

Python

[SerializableAttribute()] 
public class MaxiBarcodeWriteOptions : BarcodeWriteOptions

@interface LTMaxiBarcodeWriteOptions : LTBarcodeWriteOptions

public class MaxiBarcodeWriteOptions extends BarcodeWriteOptions

[TypeConverterAttribute()] 
[SerializableAttribute()] 
public ref class MaxiBarcodeWriteOptions : public BarcodeWriteOptions, System.ICloneable

class MaxiBarcodeWriteOptions(BarcodeWriteOptions):

Remarks

The MaxiBarcodeWriteOptions class is used to control the options when writing MaxiCode barcodes using LEADTOOLS. Set the options in two ways:

The BarcodeWriter class contains default options for each barcode symbology (or group of common symbologies). These options can be retrieved using the BarcodeWriter.GetDefaultOptions method passing BarcodeSymbology.Maxi. You can then change the members of the returned MaxiBarcodeWriteOptions by casting it from BarcodeWriteOptions to MaxiBarcodeWriteOptions.

You can also create an instance of MaxiBarcodeWriteOptions class and use it directly in the BarcodeWriter.WriteBarcode method which accepts the options as an input parameter.

The base BarcodeWriteOptions contains the following members and features:

Member	Description
BarcodeWriteOptions.ForeColor	Controls the barcode foreground color (color of the bars or symbols) to use when writing a barcode to an image.
BarcodeWriteOptions.BackColor	Controls the barcode background color (color of the spaces) to use when writing a barcode to an image.
BarcodeWriteOptions.Load and BarcodeWriteOptions.Save	Can be used to save or load the options to/from an XML file or stream.
BarcodeWriteOptions.GetSupportedSymbologies	This class overrides the base class method to return an array containing the following symbologies: BarcodeSymbology.Maxi
BarcodeOptions.FriendlyName	Gets the friendly name of this class.

In addition to the features and members, the MaxiBarcodeWriteOptions contains these MaxiCode barcodes specific features:

Member	Description
CountryCode	The country code that will be encoded when writing Maxi Code symbols using mode 2 or mode 3.
OpenSystemStandard	Write Maxi Code symbols using mode 2 or mode 3 with open system standard message.
PostalCodeChar	The alphanumeric postal code that will be encoded when writing Maxi Code symbols using mode 3.
PostalCodeNum	The numeric postal code that will be encoded when writing Maxi Code symbols using mode 2.
Resolution	The resolution of output symbol when writing Maxi Code symbols.
ServiceClass	The service class that will be encoded when writing Maxi Code symbols using mode 2 or mode 3.
SymbolModel	The encoding mode to use when writing Maxi Code.
Year	The year that will be encoded when writing Maxi Code symbols as open system standard.

Example

Java

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Barcode; 
using Leadtools.ImageProcessing; 
 
 
public void MaxiBarcode_Example() 
{ 
   string imageFileName = Path.Combine(LEAD_VARS.ImagesDir, "MyMaxiBarcodes.tif"); 
 
   BarcodeEngine engine = new BarcodeEngine(); 
 
   // Create the image to write the barcodes to 
   int resolution = 300; 
   using (RasterImage image = RasterImage.Create((int)(8.5 * resolution), (int)(11.0 * resolution), 1, resolution, RasterColor.FromKnownColor(RasterKnownColor.White))) 
   { 
      // Write two Maxi barcodes 
      WriteBarcode(engine.Writer, image, MaxiBarcodeSymbolModel.MaxiCodeMode4, "Maxi Data 1", 0); 
      WriteBarcode(engine.Writer, image, MaxiBarcodeSymbolModel.MaxiCodeMode5, "Maxi Data 2", 1000); 
 
      // Save the image 
      using (RasterCodecs codecs = new RasterCodecs()) 
      { 
         codecs.Save(image, imageFileName, RasterImageFormat.CcittGroup4, 1); 
      } 
   } 
 
   // Now read the barcodes again 
   using (RasterCodecs codecs = new RasterCodecs()) 
   { 
      using (RasterImage image = codecs.Load(imageFileName)) 
      { 
         // Read all the Maxi barcodes 
         ReadBarcodes(engine.Reader, image); 
      } 
   } 
} 
 
private void WriteBarcode(BarcodeWriter writer, RasterImage image, MaxiBarcodeSymbolModel symbolModel, string value, int startRow) 
{ 
   // Create the barcode data 
   MaxiBarcodeData barcode = BarcodeData.CreateDefaultBarcodeData(BarcodeSymbology.Maxi) as MaxiBarcodeData; 
   barcode.Value = value; 
   barcode.Symbology = BarcodeSymbology.Maxi; 
 
   // We will use the alignment to position the barcodes, so use all of the image 
   barcode.Bounds = new LeadRect(0, startRow, image.ImageWidth, image.ImageHeight); 
 
   // Set the write options 
   MaxiBarcodeWriteOptions options = new MaxiBarcodeWriteOptions(); 
 
   options.Resolution = 600; 
   options.SymbolModel = symbolModel; 
   options.CountryCode = 840; // United States country code 
   options.OpenSystemStandard = false; // Default value is false 
   options.PostalCodeChar = "ABCDEF"; 
   options.PostalCodeNum = 123456789; 
   options.ServiceClass = 123; 
   options.Year = 99; 
 
   // Write it 
   Console.WriteLine("Writing barcode with symbol model: {0} and Data: {1}", symbolModel, value); 
   writer.WriteBarcode(image, barcode, options); 
} 
 
private void ReadBarcodes(BarcodeReader reader, RasterImage image) 
{ 
   // Setup read options 
   MaxiBarcodeReadOptions options = new MaxiBarcodeReadOptions(); 
 
   Console.WriteLine("Reading Maxi barcodes"); 
   BarcodeData[] barcodes = reader.ReadBarcodes(image, LeadRect.Empty, 0, new BarcodeSymbology[] { BarcodeSymbology.Maxi }, new BarcodeReadOptions[] { options }); 
   Console.WriteLine("{0} barcodes found:", barcodes.Length); 
   foreach (MaxiBarcodeData barcode in barcodes) 
   { 
      Console.WriteLine(" At {0}, data: {1} and symbology: {2}", barcode.Bounds, barcode.Value, barcode.Symbology); 
   } 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS23\Resources\Images"; 
}

 
import java.io.File; 
import java.io.IOException; 
 
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.barcode.*; 
import leadtools.codecs.*; 
 
 
public void maxiBarcodeExample() { 
   final String LEAD_VARS_IMAGES_DIR = "C:\\LEADTOOLS23\\Resources\\Images"; 
   String imageFileName = combine(LEAD_VARS_IMAGES_DIR, "MaxiBarcode.tif"); 
   RasterCodecs codecs = new RasterCodecs(); 
   BarcodeEngine engine = new BarcodeEngine(); 
 
   // Create the image to write the barcodes to 
   int resolution = 300; 
   RasterImage image = RasterImage.create((int) (8.5 * resolution), (int) (11.0 * resolution), 1, resolution, 
         RasterColor.fromKnownColor(RasterKnownColor.WHITE)); 
 
   // Write two Maxi barcodes 
   writeBarcode(engine.getWriter(), image, MaxiBarcodeSymbolModel.MAXI_CODE_MODE4, "Maxi Data 1", 0); 
   writeBarcode(engine.getWriter(), image, MaxiBarcodeSymbolModel.MAXI_CODE_MODE5, "Maxi Data 2", 1000); 
 
   // Save the image 
   codecs.save(image, imageFileName, RasterImageFormat.CCITT_GROUP4, 1); 
 
   // Now read the barcodes again 
   image = codecs.load(imageFileName); 
 
   // Read all the Maxi barcodes 
   readBarcodes(engine.getReader(), image); 
 
   assertTrue("file unsuccessfully saved to " + imageFileName, (new File(imageFileName)).exists()); 
   System.out.printf("File saved successfully to %s%n", imageFileName); 
} 
 
// Create the barcode data 
private void writeBarcode(BarcodeWriter writer, RasterImage image, MaxiBarcodeSymbolModel symbolModel, String value, int startRow) { 
   MaxiBarcodeData barcode = (MaxiBarcodeData) BarcodeData.createDefaultBarcodeData(BarcodeSymbology.MAXI); 
   barcode.setValue(value); 
   barcode.setSymbology(BarcodeSymbology.MAXI); 
 
   // We will use the alignment to position the barcodes, so use all of the image 
   barcode.setBounds(new LeadRect(0, startRow, image.getImageWidth(), image.getImageHeight())); 
 
   // Set the write options 
   MaxiBarcodeWriteOptions options = new MaxiBarcodeWriteOptions(); 
 
   options.setResolution(600); 
   options.setSymbolModel(symbolModel); 
   options.setCountryCode(840); // United States country code 
   options.setOpenSystemStandard(false); // Default value is false 
   options.setPostalCodeChar("ABCDEF"); 
   options.setPostalCodeNum(123456789); 
   options.setServiceClass(123); 
   options.setYear(99); 
 
   // Write it 
   System.out.printf("Writing barcode with symbol model: %1s and Data: %2s%n", symbolModel, value); 
   writer.writeBarcode(image, barcode, options); 
} 
 
// Setup read options 
private void readBarcodes(BarcodeReader reader, RasterImage image) { 
   MaxiBarcodeReadOptions options = new MaxiBarcodeReadOptions(); 
 
   System.out.println("Reading Maxi barcodes"); 
   BarcodeData[] barcodes = reader.readBarcodes(image, LeadRect.getEmpty(), 0, 
         new BarcodeSymbology[] { BarcodeSymbology.MAXI }, new BarcodeReadOptions[] { options }); 
   System.out.printf("%s barcodes found:%n", barcodes.length); 
 
   for (BarcodeData barcode : barcodes) { 
      System.out.printf(" At {0}, data: {1} and symbology: {2}", barcode.getBounds(), barcode.getValue(), 
            barcode.getSymbology()); 
   } 
} 
 
public static String combine(String path1, String path2) { 
   File file = new File(path1, path2); 
   return file.getPath(); 
}