ForeColor Property

Summary

Gets or sets the barcode foreground (bars or symbol) color used when writing barcodes.

Syntax

Objective-C

C++

Java

public RasterColor ForeColor { get; set; }

Public Property ForeColor As RasterColor

@property (nonatomic, copy) LTRasterColor *foreColor

public RasterColor getForeColor() 
public void setForeColor(RasterColor value)

public: 
property RasterColor ForeColor { 
   RasterColor get(); 
   void set (    RasterColor ); 
}

Property Value

A RasterColor that specifies the barcode foreground (bars or symbol) color when writing barcodes. Default value is "Black" (RGB of #000000).

Remarks

LEADTOOLS will use ForeColor and BackColor when drawing the new barcode to the image and no special processing is performed. Note that you can specify a transparent color for BackColor to "overlay" the barcode on top of the background of the image. This however, is not recommended.

Example

This example writes a UPC-A barcode to an image with specific colors.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Barcode; 
using Leadtools.ImageProcessing; 
 
public void BarcodeWriteOptions_ColorsExample() 
{ 
   string imageFileName = Path.Combine(LEAD_VARS.ImagesDir, "MyBarcode.png"); 
 
   BarcodeEngine engine = new BarcodeEngine(); 
   BarcodeWriter writer = engine.Writer; 
 
   // We will create a Red over Yellow backround 
   RasterColor foreColor = RasterColor.FromKnownColor(RasterKnownColor.Red); 
   RasterColor backColor = RasterColor.FromKnownColor(RasterKnownColor.Yellow); 
 
   // Create a UPC-A barcode 
   BarcodeData barcode = BarcodeData.CreateDefaultBarcodeData(BarcodeSymbology.UPCA); 
   barcode.Bounds = new LeadRect(0, 0, 400, 200); 
 
   // Create a 24 BPP image the same size as the barcode 
   // The image will have red over yellow colors 
   int resolution = 300; 
   LeadRect pixels = barcode.Bounds; 
   using (RasterImage image = RasterImage.Create(pixels.Width, pixels.Height, 24, resolution, backColor)) 
   { 
      // Change the barcode colors to be Red over Yellow 
      OneDBarcodeWriteOptions options = writer.GetDefaultOptions(BarcodeSymbology.UPCA) as OneDBarcodeWriteOptions; 
      options.ForeColor = foreColor; 
      options.BackColor = backColor; 
 
      // Write the barcode 
      writer.WriteBarcode(image, barcode, options); 
 
      // Save as PNG 
      using (RasterCodecs codecs = new RasterCodecs()) 
      { 
         codecs.Save(image, imageFileName, RasterImageFormat.Png, 24); 
      } 
   } 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images"; 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.Barcode 
Imports Leadtools.ImageProcessing 
 
Public Sub BarcodeWriteOptions_ColorsExample() 
   Dim imageFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "MyBarcode.png") 
 
   Dim engine As New BarcodeEngine() 
   Dim writer As BarcodeWriter = engine.Writer 
 
   ' We will create a Red over Yellow backround 
   Dim foreColor As RasterColor = RasterColor.FromKnownColor(RasterKnownColor.Red) 
   Dim backColor As RasterColor = RasterColor.FromKnownColor(RasterKnownColor.Yellow) 
 
   ' Create a UPC-A barcode 
   Dim barcode As BarcodeData = BarcodeData.CreateDefaultBarcodeData(BarcodeSymbology.UPCA) 
   barcode.Bounds = New LeadRect(0, 0, 400, 200) 
 
   ' Create a 24 BPP image the same size as the barcode 
   ' The image will have red over yellow colors 
   Dim resolution As Integer = 300 
   Dim pixels As LeadRect = barcode.Bounds 
   Using image As RasterImage = RasterImage.Create(pixels.Width, pixels.Height, 24, resolution, backColor) 
      ' Change the barcode colors to be Red over Yellow 
      Dim options As OneDBarcodeWriteOptions = DirectCast(writer.GetDefaultOptions(BarcodeSymbology.UPCA), OneDBarcodeWriteOptions) 
      options.ForeColor = foreColor 
      options.BackColor = backColor 
 
      ' Write the barcode 
      writer.WriteBarcode(image, barcode, options) 
 
      ' Save as PNG 
      Using codecs As New RasterCodecs() 
         codecs.Save(image, imageFileName, RasterImageFormat.Png, 24) 
      End Using 
   End Using 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" 
End Class

c#[Silverlight C# Example] 
using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Forms; 
using Leadtools.Barcode; 
using Leadtools.ImageProcessing; 
using Leadtools.Examples; 
 
public void BarcodeWriteOptions_ColorsExample(Stream outStream) 
{ 
   BarcodeEngine engine = new BarcodeEngine(); 
   BarcodeWriter writer = engine.Writer; 
 
   // We will create a Red over Yellow backround 
   RasterColor foreColor = RasterColor.FromKnownColor(RasterKnownColor.Red); 
   RasterColor backColor = RasterColor.FromKnownColor(RasterKnownColor.Yellow); 
 
   // Create a UPC-A barcode 
   BarcodeData barcode = BarcodeData.CreateDefaultBarcodeData(BarcodeSymbology.UPCA); 
   barcode.Bounds = new LogicalRectangle(0, 0, 400, 200, LogicalUnit.Pixel); 
 
   // Create a 24 BPP image the same size as the barcode 
   // The image will have red over yellow colors 
   int resolution = 300; 
   LeadRect pixels = barcode.Bounds.ToRectangle(resolution, resolution); 
   using (RasterImage image = RasterImage.Create(pixels.Width, pixels.Height, 24, resolution, backColor)) 
   { 
      // Change the barcode colors to be Red over Yellow 
      OneDBarcodeWriteOptions options = writer.GetDefaultOptions(BarcodeSymbology.UPCA) as OneDBarcodeWriteOptions; 
      options.ForeColor = foreColor; 
      options.BackColor = backColor; 
 
      // Write the barcode 
      writer.WriteBarcode(image, barcode, options); 
 
      // Save as PNG 
      RasterCodecs codecs = new RasterCodecs(); 
      codecs.Save(image, outStream, RasterImageFormat.Png, 24); 
   } 
} 
vb[Silverlight VB Example] 
Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.Forms 
Imports Leadtools.Barcode 
Imports Leadtools.ImageProcessing 
 
Public Sub BarcodeWriteOptions_ColorsExample(ByVal outStream As Stream) 
   Dim engine As BarcodeEngine = New BarcodeEngine() 
   Dim writer As BarcodeWriter = engine.Writer 
 
   ' We will create a Red over Yellow backround 
   Dim foreColor As RasterColor = RasterColor.FromKnownColor(RasterKnownColor.Red) 
   Dim backColor As RasterColor = RasterColor.FromKnownColor(RasterKnownColor.Yellow) 
 
   ' Create a UPC-A barcode 
   Dim barcode As BarcodeData = BarcodeData.CreateDefaultBarcodeData(BarcodeSymbology.UPCA) 
   barcode.Bounds = New LogicalRectangle(0, 0, 400, 200, LogicalUnit.Pixel) 
 
   ' Create a 24 BPP image the same size as the barcode 
   ' The image will have red over yellow colors 
   Dim resolution As Integer = 300 
   Dim pixels As LeadRect = barcode.Bounds.ToRectangle(resolution, resolution) 
   Using image As RasterImage = RasterImage.Create(pixels.Width, pixels.Height, 24, resolution, backColor) 
      ' Change the barcode colors to be Red over Yellow 
      Dim options As OneDBarcodeWriteOptions = TryCast(writer.GetDefaultOptions(BarcodeSymbology.UPCA), OneDBarcodeWriteOptions) 
      options.ForeColor = foreColor 
      options.BackColor = backColor 
 
      ' Write the barcode 
      writer.WriteBarcode(image, barcode, options) 
 
      ' Save as PNG 
      Dim codecs As RasterCodecs = New RasterCodecs() 
      codecs.Save(image, outStream, RasterImageFormat.Png, 24) 
   End Using 
End Sub

Requirements

Target Platforms

Reference

BarcodeWriteOptions Class

BarcodeWriteOptions Members

BackColor Property

Download our FREE evaluation

Help Version 20.0.2020.4.2

Leadtools.Barcode Assembly

Introduction

Getting Started

Namespaces

Leadtools.Barcode Namespace

Assemblies