- image
- RasterImage referencing the bitmap that holds the image data.
- data
- BarcodeData class that contains the barcode information to be written over the image.
- codeColor
- BarcodeColor class that contains the color information to be written over the image.
- flags
- Flags that indicate the method behavior. Values can be combined when appropriate, by using a bitwise OR (|). Pass BarcodeWriteFlags.None to use the default values, based on the type of barcode that has been written.
- code1d
- Barcode1d class that contains the information related to linear barcodes.
- codePdf
- BarcodeWritePdf class that contains the information related to PDF417 and MicroPDF417 barcodes.
- codeDatamatrix
- BarcodeWriteDatamatrix class that contains the information related to Data Matrix barcodes.
- codeQr
- BarcodeWriteQr class that contains the information related to QR barcodes.
- sizeRectangle
- Ignored, pass.LeadRect.Empty.
Visual Basic (Declaration) | |
---|---|
Public Sub Write( _ ByVal image As RasterImage, _ ByVal data As BarcodeData, _ ByVal codeColor As BarcodeColor, _ ByVal flags As BarcodeWriteFlags, _ ByVal code1d As Barcode1d, _ ByVal codePdf As BarcodeWritePdf, _ ByVal codeDatamatrix As BarcodeWriteDatamatrix, _ ByVal codeQr As BarcodeWriteQr, _ ByVal sizeRectangle As LeadRect _ ) |
Visual Basic (Usage) | Copy Code |
---|---|
Dim instance As BarcodeEngine Dim image As RasterImage Dim data As BarcodeData Dim codeColor As BarcodeColor Dim flags As BarcodeWriteFlags Dim code1d As Barcode1d Dim codePdf As BarcodeWritePdf Dim codeDatamatrix As BarcodeWriteDatamatrix Dim codeQr As BarcodeWriteQr Dim sizeRectangle As LeadRect instance.Write(image, data, codeColor, flags, code1d, codePdf, codeDatamatrix, codeQr, sizeRectangle) |
C# | |
---|---|
public void Write( RasterImage image, BarcodeData data, BarcodeColor codeColor, BarcodeWriteFlags flags, Barcode1d code1d, BarcodeWritePdf codePdf, BarcodeWriteDatamatrix codeDatamatrix, BarcodeWriteQr codeQr, LeadRect sizeRectangle ) |
C++/CLI | |
---|---|
public: void Write( RasterImage^ image, BarcodeData^ data, BarcodeColor^ codeColor, BarcodeWriteFlags flags, Barcode1d^ code1d, BarcodeWritePdf^ codePdf, BarcodeWriteDatamatrix^ codeDatamatrix, BarcodeWriteQr^ codeQr, LeadRect sizeRectangle ) |
Parameters
- image
- RasterImage referencing the bitmap that holds the image data.
- data
- BarcodeData class that contains the barcode information to be written over the image.
- codeColor
- BarcodeColor class that contains the color information to be written over the image.
- flags
- Flags that indicate the method behavior. Values can be combined when appropriate, by using a bitwise OR (|). Pass BarcodeWriteFlags.None to use the default values, based on the type of barcode that has been written.
- code1d
- Barcode1d class that contains the information related to linear barcodes.
- codePdf
- BarcodeWritePdf class that contains the information related to PDF417 and MicroPDF417 barcodes.
- codeDatamatrix
- BarcodeWriteDatamatrix class that contains the information related to Data Matrix barcodes.
- codeQr
- BarcodeWriteQr class that contains the information related to QR barcodes.
- sizeRectangle
- Ignored, pass.LeadRect.Empty.
Visual Basic | Copy Code |
---|---|
Public Sub WriteExample() ' Load an image Dim codecs As RasterCodecs = New RasterCodecs() codecs.ThrowExceptionsOnInvalidImages = True Dim image As RasterImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "barcode1.tif")) Dim barEngine As BarcodeEngine Try ' Unlock barcode support. ' Note that this is a sample key, which will not work in your toolkit RasterSupport.Unlock(RasterSupportType.BarcodesDataMatrixWrite, "TestKey") ' Initialize barcodes barEngine = New BarcodeEngine() Dim data As BarcodeData = New BarcodeData() Dim rc As LeadRect = New LeadRect(100, 100, 0, 0) data.Unit = BarcodeUnit.ScanlinesPerPixels data.Location = rc data.SearchType = BarcodeSearchTypeFlags.DatamatrixDefault Dim barcodeText As String() barcodeText = New String(0) {} barcodeText(0) = "Data Matrix Default Size" data.Data = BarcodeData.ConvertFromStringArray(barcodeText) Dim barColor As BarcodeColor = New BarcodeColor() barColor.BarColor = RasterColor.FromKnownColor(RasterKnownColor.Black) barColor.SpaceColor = RasterColor.FromKnownColor(RasterKnownColor.White) Dim bar1d As Barcode1d = New Barcode1d() Dim barPDF As BarcodeWritePdf = New BarcodeWritePdf() Dim barDM As BarcodeWriteDatamatrix = New BarcodeWriteDatamatrix() barDM.Justify = BarcodeJustifyFlags.Right barDM.FileIdHigh = 0 barDM.FileIdLow = 0 barDM.GroupNumber = 0 barDM.GroupTotal = 0 barDM.XModule = 0 Dim barQR As BarcodeWriteQr = New BarcodeWriteQr() barEngine.Write(image, data, barColor, BarcodeWriteFlags.UseColors Or BarcodeWriteFlags.Transparent Or BarcodeWriteFlags.DisableCompression, bar1d, barPDF, barDM, barQR, LeadRect.Empty) Catch ex As BarcodeException Console.WriteLine(ex.Message) End Try End Sub Public NotInheritable Class LEAD_VARS Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" End Class |
C# | Copy Code |
---|---|
public void WriteExample() { // Load an image RasterCodecs codecs = new RasterCodecs(); codecs.ThrowExceptionsOnInvalidImages = true; string fileName = Path.Combine(LEAD_VARS.ImagesDir, "barcode1.tif"); RasterImage image = codecs.Load(fileName); BarcodeEngine barEngine; try { // Unlock barcode support. // Note that this is a sample key, which will not work in your toolkit RasterSupport.Unlock(RasterSupportType.BarcodesDataMatrixWrite, "TestKey"); // Initialize barcodes barEngine = new BarcodeEngine(); BarcodeData data = new BarcodeData(); LeadRect rc = new LeadRect(100, 100, 0, 0); data.Unit = BarcodeUnit.ScanlinesPerPixels; data.Location = rc; data.SearchType = BarcodeSearchTypeFlags.DatamatrixDefault; string[] barcodeText; barcodeText = new string[1]; barcodeText[0] = "Data Matrix Default Size"; data.Data = BarcodeData.ConvertFromStringArray(barcodeText); BarcodeColor barColor = new BarcodeColor(); barColor.BarColor = RasterColor.FromKnownColor(RasterKnownColor.Black); barColor.SpaceColor = RasterColor.FromKnownColor(RasterKnownColor.White); Barcode1d bar1d = new Barcode1d(); BarcodeWritePdf barPDF = new BarcodeWritePdf(); BarcodeWriteDatamatrix barDM = new BarcodeWriteDatamatrix(); barDM.Justify = BarcodeJustifyFlags.Right; barDM.FileIdHigh = 0; barDM.FileIdLow = 0; barDM.GroupNumber = 0; barDM.GroupTotal = 0; barDM.XModule = 0; BarcodeWriteQr barQR = new BarcodeWriteQr(); barEngine.Write(image, data, barColor, BarcodeWriteFlags.UseColors | BarcodeWriteFlags.Transparent | BarcodeWriteFlags.DisableCompression, bar1d, barPDF, barDM, barQR, LeadRect.Empty); } catch (BarcodeException ex) { Console.WriteLine(ex.Message); } } static class LEAD_VARS { public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images"; } |
SilverlightCSharp | Copy Code |
---|---|
public void WriteExample(RasterImage image) { BarcodeEngine barEngine; try { // Unlock barcode support. // Note that this is a sample key, which will not work in your toolkit RasterSupport.Unlock(RasterSupportType.BarcodesDataMatrixWrite, "TestKey"); // Initialize barcodes barEngine = new BarcodeEngine(); BarcodeData data = new BarcodeData(); LeadRect rc = new LeadRect(100, 100, 0, 0); data.Unit = BarcodeUnit.ScanlinesPerPixels; data.Location = rc; data.SearchType = BarcodeSearchTypeFlags.DatamatrixDefault; string[] barcodeText; barcodeText = new string[1]; barcodeText[0] = "Data Matrix Default Size"; data.Data = BarcodeData.ConvertFromStringArray(barcodeText); BarcodeColor barColor = new BarcodeColor(); barColor.BarColor = RasterColor.FromKnownColor(RasterKnownColor.Black); barColor.SpaceColor = RasterColor.FromKnownColor(RasterKnownColor.White); Barcode1d bar1d = new Barcode1d(); BarcodeWritePdf barPDF = new BarcodeWritePdf(); BarcodeWriteDatamatrix barDM = new BarcodeWriteDatamatrix(); barDM.Justify = BarcodeJustifyFlags.Right; barDM.FileIdHigh = 0; barDM.FileIdLow = 0; barDM.GroupNumber = 0; barDM.GroupTotal = 0; barDM.XModule = 0; BarcodeWriteQr barQR = new BarcodeWriteQr(); barEngine.Write(image, data, barColor, BarcodeWriteFlags.UseColors | BarcodeWriteFlags.Transparent | BarcodeWriteFlags.DisableCompression, bar1d, barPDF, barDM, barQR, LeadRect.Empty); } catch (BarcodeException ex) { Console.WriteLine(ex.Message); } } |
SilverlightVB | Copy Code |
---|---|
Public Sub WriteExample(ByVal image As RasterImage) Dim barEngine As BarcodeEngine Try ' Unlock barcode support. ' Note that this is a sample key, which will not work in your toolkit RasterSupport.Unlock(RasterSupportType.BarcodesDataMatrixWrite, "TestKey") ' Initialize barcodes barEngine = New BarcodeEngine() Dim data As BarcodeData = New BarcodeData() Dim rc As LeadRect = New LeadRect(100, 100, 0, 0) data.Unit = BarcodeUnit.ScanlinesPerPixels data.Location = rc data.SearchType = BarcodeSearchTypeFlags.DatamatrixDefault Dim barcodeText As String() barcodeText = New String(0){} barcodeText(0) = "Data Matrix Default Size" data.Data = BarcodeData.ConvertFromStringArray(barcodeText) Dim barColor As BarcodeColor = New BarcodeColor() barColor.BarColor = RasterColor.FromKnownColor(RasterKnownColor.Black) barColor.SpaceColor = RasterColor.FromKnownColor(RasterKnownColor.White) Dim bar1d As Barcode1d = New Barcode1d() Dim barPDF As BarcodeWritePdf = New BarcodeWritePdf() Dim barDM As BarcodeWriteDatamatrix = New BarcodeWriteDatamatrix() barDM.Justify = BarcodeJustifyFlags.Right barDM.FileIdHigh = 0 barDM.FileIdLow = 0 barDM.GroupNumber = 0 barDM.GroupTotal = 0 barDM.XModule = 0 Dim barQR As BarcodeWriteQr = New BarcodeWriteQr() barEngine.Write(image, data, barColor, BarcodeWriteFlags.UseColors Or BarcodeWriteFlags.Transparent Or BarcodeWriteFlags.DisableCompression, bar1d, barPDF, barDM, barQR, LeadRect.Empty) Catch ex As BarcodeException Console.WriteLine(ex.Message) End Try End Sub |
You must pass a valid RasterImage to this method. If you do not pass a valid Rasterimage, the method will throw an exception.
The Write method will write the barcode symbol over the image using the rectangle defined by the Location property.
However, if the bitmap has a region, this function will write the barcode using the region boundaries. If the region is non-rectangular, the barcode will be written to the rectangle bounding the region and subsequently clipped to the given region. This might cause the resulting barcode to be unreadable.
If you set the flags parameter to .UseColors, then this method will use the codeColor parameter, otherwise the method will ignore it and use the default colors of black for bars and white for spaces.
Using colors does not apply for 1 bit per pixel images.
The BarcodeWriteFlags.UseColors and BarcodeWriteFlags.Transparent are used with all barcode types.
For a table containing information useful when writing 1D barcode data see http://www.leadtools.com/SDK/Document/Document-Addon-Barcodelinear1D-chart.htm.
Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7