TyKonKet.BarcodeGenerator 2.0.0

Barcode Generator

Barcode generator based on SkiaSharp library, supports the following encoders:

• EAN-13
• UPC-A
• ISBN
• EAN-8
• CODE93

Table of Contents

• Installation
• Usage
• Getting Started
• Breaking Changes
• Roadmap

Installation

BarcodeGenerator is available as a convenient NuGet package.
To install the package, use one of the following commands:

PM> Install-Package TyKonKet.BarcodeGenerator

nuget install TyKonKet.BarcodeGenerator

Usage

You can generate all the barcodes using the Barcode class. The Barcode class has a constructor that accepts an Action<BarcodeOptions> delegate to set the barcode options. The BarcodeOptions class has the following properties:

• Encode: Specifies the encoding type (e.g., Encodes.Code93).
• Height: Sets the height of the barcode.
• Scale: Sets the scale of the barcode.
• Margins: Sets the margins around the barcode.
• BackgroundColor: Sets the background color of the barcode.
• Color: Sets the color of the barcode.
• Font: Sets the font for the barcode text.
• FontStyle: Sets the font style for the barcode text.
• DrawText: Specifies whether to draw text below the barcode.

Getting Started

Here is an example of how to generate a barcode using the Barcode class:

using SkiaSharp;
using TyKonKet.BarcodeGenerator;

internal static class Example
{
    private static void CreateBarcodeImage()
    {
        // Set up the barcode generator with specific options
        using var barcodeGenerator = new Barcode(options =>
        {
            // Set the type of barcode to Code93
            options.Type = BarcodeTypes.Code93;
            // Set the height of the barcode
            options.Height = 30;
            // Set the scaling factor for the barcode
            options.Scaling = 10;
            // Set the margins around the barcode
            options.Margins = 2;
            // Set the background color of the barcode to transparent
            options.BackgroundColor = SKColors.Transparent;
            // Set the foreground color of the barcode to black
            options.ForegroundColor = SKColors.Black;
            // Enable rendering of text below the barcode
            options.RenderText = true;
            // Use the specified font family and style for the text
            options.UseTypeface("Arial", SKFontStyle.Normal);
        });

        // Encode the barcode with the specified string
        barcodeGenerator.Encode("THE-BARCODE");

        // Export the barcode image to a file
        // The file path can include the following keywords:
        // - {barcode}: The barcode string.
        // - {format}: The image format (e.g., png, jpg).
        // - {quality}: The image quality (1-100).
        barcodeGenerator.Export("path/{barcode}_{quality}.{format}", SKEncodedImageFormat.Png, 100);
    }
}

Breaking Changes

• Starting with version 2.0.0, the library is no longer compatible with .NET Standard 1.3 since it uses SkiaSharp 3.116.1, which requires .NET Standard 2.0.
• Starting with version 2.0.0, the API has been changed to be more user-friendly and to allow more customization. Follow the examples in the README.md file to see how to use the new API.

Roadmap

• Update the README.md documentation
• Add support for CODE39 and CODE128 encoders
• Add support for more barcode types
• Add an API to validate the barcode