Skip to content

feat: Add Aspose.BarCode .NET C# Examples — Maxicode Barcode #102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
asadalikhan90 merged 1 commit into from
Aug 13, 2026
Merged

feat: Add Aspose.BarCode .NET C# Examples — Maxicode Barcode #102

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
101 changes: 37 additions & 64 deletions ...ustom-background-color-to-maxicode-barcode-and-verify-that-decoding-remains-successful.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,96 +1,69 @@
// Title: Custom Background Color for MaxiCode Barcode
// Description: Demonstrates applying a custom background color to a MaxiCode barcode and confirming that it can still be decoded correctly.
// Category-Description: This example belongs to the Aspose.BarCode generation and recognition category, focusing on MaxiCode symbology. It showcases the use of ComplexBarcodeGenerator to create a MaxiCode with custom visual settings, and BarCodeReader with ComplexCodetextReader to decode the generated image. Developers working with shipping, logistics, or inventory systems often need to customize barcode appearance while ensuring reliable scanning.
// Title: Apply custom background color to a MaxiCode barcode and verify decoding
// Description: Demonstrates setting a custom background color for a MaxiCode barcode using Aspose.BarCode, saving it as an image, and confirming that the barcode can still be decoded correctly.
// Category-Description: This example belongs to the Aspose.BarCode generation and recognition category. It showcases the use of BarcodeGenerator to customize visual appearance (background and bar colors) and BarCodeReader to decode the generated image. Typical use cases include branding barcodes with corporate colors while ensuring they remain machine‑readable. Developers often need to adjust visual parameters without breaking decoding, and this snippet illustrates that workflow.
// Prompt: Apply a custom background color to a MaxiCode barcode and verify that decoding remains successful.
// Tags: maxicode, background color, barcode generation, barcode recognition, aspose.barcode, c#

using System;
using System.IO;
using Aspose.BarCode;
using Aspose.BarCode.Generation;
using Aspose.BarCode.BarCodeRecognition;
using Aspose.BarCode.ComplexBarcode;
using Aspose.Drawing;

/// <summary>
/// Generates a MaxiCode barcode with a custom background color,
/// saves it as an image, and verifies that the barcode can be decoded successfully.
/// saves it to a PNG file, and then verifies that the barcode can be decoded successfully.
/// </summary>
class Program
{
/// <summary>
/// Entry point of the example. Creates a MaxiCode with a light‑yellow background,
/// writes it to a PNG file, and then reads the file back to confirm decoding.
/// Entry point of the example. Creates the barcode, applies visual customizations,
/// saves the image, and validates decoding.
/// </summary>
static void Main()
{
// Define the output file name.
string outputPath = "maxicode.png";
// Define the output file path for the generated barcode image.
string imagePath = "maxicode.png";

// Prepare MaxiCode codetext (Mode 2 example) with postal code, country code, and service category.
var maxiCode = new MaxiCodeCodetextMode2
// --------------------------------------------------------------------
// Generate a MaxiCode barcode with custom colors.
// --------------------------------------------------------------------
using (BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.MaxiCode, "Sample MaxiCode"))
{
PostalCode = "524032140", // 9‑digit US postal code
CountryCode = 56, // USA
ServiceCategory = 999 // Example service category
};
// Set a custom background color (light orange‑yellow).
generator.Parameters.BackColor = Color.FromArgb(255, 255, 224, 128);

// Add a second message to the MaxiCode.
var secondMessage = new MaxiCodeStandardSecondMessage
{
Message = "Sample MaxiCode"
};
maxiCode.SecondMessage = secondMessage;

// Generate the MaxiCode barcode with a custom background color.
using (var complexGenerator = new ComplexBarcodeGenerator(maxiCode))
{
// Set background to light yellow (RGB 255,255,224).
complexGenerator.Parameters.BackColor = Aspose.Drawing.Color.FromArgb(255, 255, 224);
// Optionally set the foreground (bar) color for better contrast.
generator.Parameters.Barcode.BarColor = Color.Black;

// Create the barcode image.
using (var bitmap = complexGenerator.GenerateBarCodeImage())
{
// Save the image as PNG.
bitmap.Save(outputPath, Aspose.Drawing.Imaging.ImageFormat.Png);
}
// Save the customized barcode image to the specified file.
generator.Save(imagePath);
}

// Verify that the image file was created.
if (!File.Exists(outputPath))
// --------------------------------------------------------------------
// Decode the saved barcode image to ensure the custom background does not affect readability.
// --------------------------------------------------------------------
BaseDecodeType decodeType = DecodeType.MaxiCode;
using (BarCodeReader reader = new BarCodeReader(imagePath, decodeType))
{
Console.WriteLine("Failed to create barcode image.");
return;
}
// Use the highest quality preset to improve detection reliability.
reader.QualitySettings = QualitySettings.MaxQuality;

// Read and decode the generated MaxiCode barcode.
using (var reader = new BarCodeReader(outputPath, DecodeType.MaxiCode))
{
foreach (var result in reader.ReadBarCodes())
{
// Decode the raw codetext using the appropriate MaxiCode mode.
var decoded = ComplexCodetextReader.TryDecodeMaxiCode(
result.Extended.MaxiCode.MaxiCodeMode,
result.CodeText);

// Check if decoding produced the expected Mode 2 codetext.
if (decoded is MaxiCodeCodetextMode2 decodedMode2)
{
Console.WriteLine("Decoding successful:");
Console.WriteLine($"Postal Code: {decodedMode2.PostalCode}");
Console.WriteLine($"Country Code: {decodedMode2.CountryCode}");
Console.WriteLine($"Service Category: {decodedMode2.ServiceCategory}");
// Read all barcodes present in the image.
BarCodeResult[] results = reader.ReadBarCodes();

// Output the second message if present.
if (decodedMode2.SecondMessage is MaxiCodeStandardSecondMessage stdMsg)
{
Console.WriteLine($"Message: {stdMsg.Message}");
}
}
else
// Evaluate decoding results.
bool success = false;
foreach (BarCodeResult result in results)
{
if (!string.IsNullOrEmpty(result.CodeText))
{
Console.WriteLine("Decoding failed or unexpected codetext type.");
Console.WriteLine($"Decoded CodeText: {result.CodeText}");
success = true;
}
}

Console.WriteLine(success ? "Decoding succeeded." : "Decoding failed.");
}
}
}
56 changes: 22 additions & 34 deletions ...ustom-foreground-color-to-maxicode-mode-2-barcode-using-generator-s-forecolor-property.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,57 +1,45 @@
// Title: Apply custom foreground color to a MaxiCode Mode 2 barcode
// Description: This example creates a MaxiCode Mode 2 barcode, sets a custom bar (foreground) color, and saves it as a PNG image. It demonstrates how to customize the visual appearance of complex barcodes using Aspose.BarCode.
// Category-Description: The sample belongs to the Aspose.BarCode complex barcode generation category, where developers work with multi‑message symbologies such as MaxiCode. It showcases the use of ComplexBarcodeGenerator, MaxiCodeCodetextMode2, and related parameter classes to configure barcode data and appearance. Typical scenarios include shipping labels, parcel tracking, and logistics applications that require colored MaxiCode symbols.
// Title: Custom foreground color for MaxiCode Mode 2 barcode
// Description: Demonstrates generating a MaxiCode Mode 2 barcode and applying a custom foreground (bar) color using Aspose.BarCode.
// Category-Description: This example belongs to the Aspose.BarCode complex barcode generation category. It showcases the use of ComplexBarcodeGenerator with MaxiCodeCodetextMode2, configuring barcode appearance via the Parameters.Barcode.BarColor property, and saving the result as an image. Developers working with high‑density 2‑D barcodes such as MaxiCode often need to customize visual attributes for branding or readability, making this pattern a common starting point.
// Prompt: Apply a custom foreground color to a MaxiCode Mode 2 barcode using the generator's ForeColor property.
// Tags: maxicode, color, generation, png, aspose.barcode, complexbarcodegenerator, barcode
// Tags: maxicode, barcode, color, foreground, generation, aspose.barcode, complexbarcode, png

using System;
using System.IO;
using Aspose.BarCode;
using Aspose.BarCode.Generation;
using Aspose.BarCode.ComplexBarcode;
using Aspose.Drawing;
using Aspose.Drawing.Imaging;

/// <summary>
/// Demonstrates applying a custom foreground color to a MaxiCode Mode 2 barcode and saving it as PNG.
/// Generates a MaxiCode Mode 2 barcode with a custom foreground color and saves it as a PNG file.
/// </summary>
class Program
{
/// <summary>
/// Entry point that builds the MaxiCode data, configures the barcode color, generates the image, and writes it to disk.
/// Entry point of the example. Creates the barcode data, configures the generator, and writes the image to disk.
/// </summary>
static void Main()
{
// Prepare MaxiCode Mode 2 codetext with required fields
var maxiCodeCodetext = new MaxiCodeCodetextMode2
// Prepare MaxiCode Mode 2 codetext with sample values.
var maxiCodeData = new MaxiCodeCodetextMode2
{
PostalCode = "524032140", // 9‑digit US postal code
CountryCode = 56, // USA numeric country code
ServiceCategory = 999 // Example service category
PostalCode = "524032140",
CountryCode = 56,
ServiceCategory = 999,
SecondMessage = new MaxiCodeStandardSecondMessage { Message = "Sample message" }
};

// Create and assign the standard second message
var secondMessage = new MaxiCodeStandardSecondMessage
// Initialize the complex barcode generator using the prepared codetext.
using (var generator = new ComplexBarcodeGenerator(maxiCodeData))
{
Message = "Sample MaxiCode"
};
maxiCodeCodetext.SecondMessage = secondMessage;

// Initialize the generator with the prepared codetext
using (var generator = new ComplexBarcodeGenerator(maxiCodeCodetext))
{
// Set a custom foreground (bar) color for the barcode
generator.Parameters.Barcode.BarColor = Color.Blue;

// Generate the barcode image in memory
generator.GenerateBarCodeImage();

// Define output file path and save the image as PNG
const string outputPath = "maxicode_mode2.png";
generator.Save(outputPath, BarCodeImageFormat.Png);
// Set a custom foreground (bar) color for the barcode.
generator.Parameters.Barcode.BarColor = Aspose.Drawing.Color.Red;

// Inform the user where the file was saved
Console.WriteLine($"Barcode saved to {Path.GetFullPath(outputPath)}");
// Generate the barcode image.
using (Aspose.Drawing.Bitmap image = generator.GenerateBarCodeImage())
{
// Save the generated image to a PNG file.
image.Save("MaxiCodeMode2_Red.png");
}
}
}
}
Loading
Loading