ForeColor Property (IBarcodeWriteOptions)

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

Syntax

Visual Basic
C#
WinRT C#
Objective-C
Java
WinRT JavaScript
C++

[DisplayNameAttribute("Fore color")]
[DescriptionAttribute("Foreground (bar) color to use when writing the barcode")]
[CategoryAttribute("				Colors")]
RasterColor ForeColor {get; set;}

'Declaration
 
<DisplayNameAttribute("Fore color")>
<DescriptionAttribute("Foreground (bar) color to use when writing the barcode")>
<CategoryAttribute("				Colors")>
Property ForeColor As RasterColor

'Usage
 
Dim instance As IBarcodeWriteOptions
Dim value As RasterColor
 
instance.ForeColor = value
 
value = instance.ForeColor

[DisplayNameAttribute("Fore color")]
[DescriptionAttribute("Foreground (bar) color to use when writing the barcode")]
[CategoryAttribute("				Colors")]
RasterColor ForeColor {get; set;}

ObjectiveC Syntax

Java Syntax

DisplayNameAttribute("Fore color")
DescriptionAttribute("Foreground (bar) color to use when writing the barcode")
CategoryAttribute("				Colors")
get_ForeColor();
set_ForeColor(value);

[DisplayNameAttribute("Fore color")]
[DescriptionAttribute("Foreground (bar) color to use when writing the barcode")]
[CategoryAttribute("				Colors")]
property RasterColor ForeColor {
   RasterColor get();
   void set (    RasterColor value);
}

Property Value

A Leadtools.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

Visual Basic
C#
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Copy Code

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 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 = 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

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 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
         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";
}

[TestMethod]
public async Task BarcodeWriteOptions_ColorsExample()
{
   string imageFileName = @"MyBarcode.png";
   BarcodeEngine engine = new BarcodeEngine();
   BarcodeWriter writer = engine.Writer;

   // We will create a Red over Yellow backround
   RasterColor foreColor = RasterColorHelper.FromKnownColor(RasterKnownColor.Red);
   RasterColor backColor = RasterColorHelper.FromKnownColor(RasterKnownColor.Yellow);

   // Create a UPC-A barcode
   BarcodeData barcode = BarcodeData.CreateDefaultBarcodeData(BarcodeSymbology.UPCA);
   barcode.Bounds = LeadRectHelper.Create(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())
      {
         StorageFile saveFile = await Tools.AppLocalFolder.CreateFileAsync(imageFileName);
         await codecs.SaveAsync(image, LeadStreamFactory.Create(saveFile), RasterImageFormat.Png, 24);
      }
   }
}

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);
   }
}

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: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

IBarcodeWriteOptions Interface
IBarcodeWriteOptions Members
BackColor Property