Customize Barcode Appearance

This documentation explains how to customize the appearance of barcodes using the Aspose.BarCode Cloud SDK for .NET. It provides details on the available methods, customization options, and examples of usage.

Methods

GenerateAsync: Generates a barcode via GET request.
GenerateBodyAsync: Generates a barcode via POST request with JSON or XML body.
GenerateMultipartAsync: Generates a barcode via POST request with multipart form data.

Customization Options

When generating a barcode, you can customize various aspects of its appearance using the properties of the request classes.

Key Properties:

BarcodeType: Specifies the type of barcode to generate (e.g. QR, Aztec, Pdf417, Code39, etc).
Data: The data to encode in the barcode.
ImageFormat: Specifies the output format of the barcode image (e.g., Png, Jpeg, Svg).
ForegroundColor: Color of the barcode bars, supports standard color names or ARGB values (e.g., AliceBlue or #FF000000).
BackgroundColor: Background color of the barcode image.
TextLocation: Position of the code text relative to the barcode (Below, Above, None).
Units: Measurement units for image dimensions (Pixel, Inch, Millimeter).
Resolution: Resolution of the image in dpi.
ImageHeight and ImageWidth: Dimensions of the barcode image.
RotationAngle: Rotation angle of the barcode (e.g., 0, 90, 180).

Barcode Type-Specific Parameters

In addition to the common appearance settings above, the API exposes advanced parameters that apply only to specific barcode types. They are ignored when a different barcode type is generated.

QR, MicroQR and RectMicroQR

QrEncodeMode: QR barcode encode mode (Auto, Extended, Binary, ECI).
QrErrorLevel: QR error correction level (LevelL, LevelM, LevelQ, LevelH).
QrVersion: QR barcode version (Auto, Version01–Version40). Auto selects the smallest version that fits the data.
QrECIEncoding: ECI encoding for the QR barcode data (e.g., UTF8, ISO_8859_1).
QrAspectRatio: QR barcode aspect ratio, from 0 to 1.
MicroQRVersion: MicroQR version (Auto, M1–M4). Used when the barcode type is MicroQR.
RectMicroQrVersion: RectMicroQR version (Auto, R7x43–R17x139). Used when the barcode type is RectMicroQR.

Code128

Code128EncodeMode: Controls which Code 128 subset is used (Auto, CodeA, CodeB, CodeAB, CodeC, CodeAC, CodeBC).

PDF417, MacroPDF417 and MicroPDF417

Pdf417EncodeMode: PDF417 encode mode (Auto, Binary, ECI, Extended).
Pdf417ErrorLevel: PDF417 error correction level (Level0–Level8).
Pdf417ECIEncoding: ECI encoding for the PDF417 barcode data.
Pdf417Truncate: Whether to use the truncated PDF417 format (removes the right-side stop pattern).
Pdf417Columns: Number of columns (1–30, or 0 for auto).
Pdf417Rows: Number of rows (3–90, or 0 for automatic).
Pdf417AspectRatio: Height/width ratio of the barcode module (2–5 for MicroPDF417; 3–5 for PDF417 and MacroPDF417).
Pdf417MacroCharacters: Macro character to prepend for structured append (None, Macro05, Macro06).
Pdf417IsReaderInitialization: Whether the barcode is used for reader initialization (programming).
Pdf417IsLinked: Whether to use linked mode (for MicroPDF417).
Pdf417IsCode128Emulation: Whether to use Code128 emulation (for MicroPDF417).

Examples

Example 1: Generating a Barcode with GET Request

using Aspose.BarCode.Cloud.Sdk.Api;
using Aspose.BarCode.Cloud.Sdk.Interfaces;
using Aspose.BarCode.Cloud.Sdk.Model;

using System;
using System.IO;
using System.Reflection;
using System.Threading.Tasks;

namespace GenerateSnippets;

internal static class Program
{
    private static Configuration MakeConfiguration()
    {
        var config = new Configuration();

        string? envToken = Environment.GetEnvironmentVariable("TEST_CONFIGURATION_ACCESS_TOKEN");
        if (string.IsNullOrEmpty(envToken))
        {
            config.ClientId = "Client Id from https://dashboard.aspose.cloud/applications";
            config.ClientSecret = "Client Secret from https://dashboard.aspose.cloud/applications";
        }
        else
        {
            config.JwtToken = envToken;
        }

        return config;
    }

    public static async Task Main(string[] args)
    {
        string fileName = Path.GetFullPath(Path.Join("Tests", "test_data",
            "qr.png"
        ));

        GenerateApi generateApi = new GenerateApi(MakeConfiguration());

        var generated = await generateApi.GenerateAsync(barcodeType: EncodeBarcodeType.QR,
            data: "Aspose.BarCode.Cloud",
            barcodeImageParams: new BarcodeImageParams
            {
                ImageFormat = BarcodeImageFormat.Png,
                ForegroundColor = "Black",
                BackgroundColor = "White",
                TextLocation = CodeLocation.Below,
                Resolution = 300,
                ImageHeight = 200,
                ImageWidth = 200
            },
            qrParams: new QrParams
            {
                QrEncodeMode = QREncodeMode.Auto,
                QrErrorLevel = QRErrorLevel.LevelM,
                QrVersion = QRVersion.Auto,
                QrAspectRatio = 0.75f
            });

        await using FileStream stream = File.Create(fileName);
        await generated.CopyToAsync(stream);

        Console.WriteLine($"File '{fileName}' generated.");
    }
}

Result Image is:

Example 2: Generating a Barcode with POST Request (JSON Body)

using Aspose.BarCode.Cloud.Sdk.Api;
using Aspose.BarCode.Cloud.Sdk.Interfaces;
using Aspose.BarCode.Cloud.Sdk.Model;

using System;
using System.IO;
using System.Reflection;
using System.Threading.Tasks;

namespace GenerateSnippets;

internal static class Program
{
    private static Configuration MakeConfiguration()
    {
        var config = new Configuration();

        string? envToken = Environment.GetEnvironmentVariable("TEST_CONFIGURATION_ACCESS_TOKEN");
        if (string.IsNullOrEmpty(envToken))
        {
            config.ClientId = "Client Id from https://dashboard.aspose.cloud/applications";
            config.ClientSecret = "Client Secret from https://dashboard.aspose.cloud/applications";
        }
        else
        {
            config.JwtToken = envToken;
        }

        return config;
    }

    public static async Task Main(string[] args)
    {
        string fileName = Path.GetFullPath(Path.Join("Tests", "test_data",
            "QrCustom.jpeg"
        ));

        GenerateApi generateApi = new GenerateApi(MakeConfiguration());

        var generateParams = new GenerateParams
        {
            BarcodeType = EncodeBarcodeType.QR,
            EncodeData = new EncodeData { Data = "Aspose", DataType = EncodeDataType.StringData },
            BarcodeImageParams = new BarcodeImageParams
            {
                ForegroundColor = "#FF0000",
                BackgroundColor = "#FFFF00",
                ImageFormat = BarcodeImageFormat.Jpeg,
                RotationAngle = 90
            },
            QrParams = new QrParams
            {
                QrEncodeMode = QREncodeMode.Auto,
                QrErrorLevel = QRErrorLevel.LevelM,
                QrVersion = QRVersion.Auto,
                QrAspectRatio = 0.75f
            }
        };

        var generated = await generateApi.GenerateBodyAsync(generateParams);

        await using FileStream stream = File.Create(fileName);
        await generated.CopyToAsync(stream);

        Console.WriteLine($"File '{fileName}' generated.");
    }
}

Result Image is:

Example 3: Generating a Barcode with POST Request (Multipart Form)

using Aspose.BarCode.Cloud.Sdk.Api;
using Aspose.BarCode.Cloud.Sdk.Interfaces;
using Aspose.BarCode.Cloud.Sdk.Model;

using System;
using System.IO;
using System.Reflection;
using System.Threading.Tasks;

namespace GenerateSnippets;

internal static class Program
{
    private static Configuration MakeConfiguration()
    {
        var config = new Configuration();

        string? envToken = Environment.GetEnvironmentVariable("TEST_CONFIGURATION_ACCESS_TOKEN");
        if (string.IsNullOrEmpty(envToken))
        {
            config.ClientId = "Client Id from https://dashboard.aspose.cloud/applications";
            config.ClientSecret = "Client Secret from https://dashboard.aspose.cloud/applications";
        }
        else
        {
            config.JwtToken = envToken;
        }

        return config;
    }

    public static async Task Main(string[] args)
    {
        string fileName = Path.GetFullPath(Path.Join("Tests", "test_data",
            "Pdf417.svg"
        ));

        GenerateApi generateApi = new GenerateApi(MakeConfiguration());

        var generated = await generateApi.GenerateMultipartAsync(barcodeType: EncodeBarcodeType.Pdf417,
            data: "Aspose.BarCode.Cloud",
            barcodeImageParams: new BarcodeImageParams
            {
                TextLocation = CodeLocation.Above,
                ImageFormat = BarcodeImageFormat.Svg
            },
            pdf417Params: new Pdf417Params
            {
                Pdf417EncodeMode = Pdf417EncodeMode.Auto,
                Pdf417ErrorLevel = Pdf417ErrorLevel.Level2,
                Pdf417AspectRatio = 3
            });

        await using FileStream stream = File.Create(fileName);
        await generated.CopyToAsync(stream);

        Console.WriteLine($"File '{fileName}' generated.");
    }
}

Result Image is:

Set Barcode Colorscheme Save Generated Barcodes