Class BarcodeGenerator

Class BarcodeGenerator

Namespace: Aspose.BarCode.Generation
Assembly: Aspose.BarCode.dll (25.1.0)

用于后端条形码图像生成的 BarcodeGenerator。

支持的编码方式： 1D： Codabar, Code11, Code128, Code39, Code39FullASCII Code93, EAN13, EAN8, Interleaved2of5, MSI, Standard2of5, UPCA, UPCE, ISBN, GS1Code128, Postnet, Planet EAN14, SCC14, SSCC18, ITF14, SingaporePost ... 2D： Aztec, DataMatrix, PDf417, QR code ...

[XmlSerialization(Name = "Aspose.BarCode.Generator")]
public sealed class BarcodeGenerator : IDisposable

继承

object ← BarcodeGenerator

实现

IDisposable

继承成员

object.GetType(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

示例

此示例演示如何创建和保存条形码图像。

  using(var generator = new BarcodeGenerator(EncodeTypes.Code128))
  {
      generator.CodeText = "123ABC";
      generator.Save("code128.png");
  }

构造函数

BarcodeGenerator(BaseEncodeType)

创建 BarcodeGenerator 的实例。

public BarcodeGenerator(BaseEncodeType type)

参数

type BaseEncodeType

条形码编码类型。使用 Aspose.BarCode.Generation.EncodeTypes 类来设置编码方式。

BarcodeGenerator(BaseEncodeType, string)

创建 BarcodeGenerator 的实例。

public BarcodeGenerator(BaseEncodeType type, string codeText)

参数

type BaseEncodeType

条形码编码类型。使用 Aspose.BarCode.Generation.EncodeTypes 类来设置编码方式。

codeText string

待编码的文本。

属性

BarcodeType

条形码编码类型。

[XmlSerialization(Type = XmlSerializationType.Element)]
public BaseEncodeType BarcodeType { get; set; }

属性值

BaseEncodeType

CodeText

待编码的文本。

[XmlSerialization(Type = XmlSerializationType.Element)]
public string CodeText { get; set; }

属性值

string

Parameters

生成参数。

[XmlSerialization(Type = XmlSerializationType.Element)]
public BaseGenerationParameters Parameters { get; }

属性值

BaseGenerationParameters

方法

Dispose() 

public void Dispose()

ExportToXml(string)

将条形码属性导出到指定的 xml 文件

public bool ExportToXml(string xmlFile)

参数

xmlFile string

文件名称

返回

bool

导出是否成功完成。

成功时返回 True；否则返回 False

ExportToXml(Stream)

将条形码属性导出到指定的 xml 流

public bool ExportToXml(Stream xml)

参数

xml Stream

xml 流

返回

bool

导出是否成功完成。

成功时返回 True；否则返回 False

GenerateBarCodeImage()

在当前设置下生成条形码图像。

public Bitmap GenerateBarCodeImage()

返回

Bitmap

条形码图像。请参见 System.Drawing.Bitmap。

示例

此示例演示如何创建和保存条形码图像。

  using(var generator = new BarcodeGenerator(EncodeTypes.Code128))
  {
      Bitmap barcode = generator.GenerateBarCodeImage();
      barcode.Save("test.png");
  }

ImportFromXml(string)

从指定的 xml 文件导入条形码属性并创建 BarcodeGenerator 实例。

public static BarcodeGenerator ImportFromXml(string xmlFile)

参数

xmlFile string

文件名称

返回

BarcodeGenerator

BarcodeGenerator 实例

ImportFromXml(Stream)

从指定的 xml 流导入条形码属性并创建 BarcodeGenerator 实例。

public static BarcodeGenerator ImportFromXml(Stream xml)

参数

xml Stream

xml 流

返回

BarcodeGenerator

BarcodeGenerator 实例

Save(Stream, BarCodeImageFormat)

将条形码图像保存到指定格式的流中。

public void Save(Stream stream, BarCodeImageFormat format)

参数

stream Stream

输出 System.IO.Stream。

format BarCodeImageFormat

指定输出图像的文件格式。

Save(string, BarCodeImageFormat)

将条形码图像保存到特定文件中的特定格式。

public void Save(string filename, BarCodeImageFormat format)

参数

filename string

保存路径。

format BarCodeImageFormat

指定输出图像的文件格式。

Save(string)

将条形码图像保存到特定文件。

public void Save(string filename)

参数

filename string

保存路径。

SetCodeText(byte[])

将 codetext 设置为字节序列。

public void SetCodeText(byte[] codeBytes)

参数

codeBytes byte[]

codetext 的字节

SetCodeText(string, Encoding)

使用指定编码（如 UTF8、UTF16、UTF32 等）对 codetext 进行编码，带有字节顺序标记（BOM）。 1D 条形码应使用 Encoding.ASCII 或 ISO/IEC 8859-1 - Encoding.GetEncoding(28591)。2D 条形码应使用 Encoding.UTF8。

public void SetCodeText(string codeText, Encoding encoding)

参数

codeText string

CodeText 字符串

encoding Encoding

应用的编码

示例

此示例演示如何使用 SetCodeText 处理 1D 和 2D 条形码

//使用 7 位 ASCII 编码编码 1D 条形码的 codetext，缺少字节顺序标记（BOM）
using (BarcodeGenerator gen = new BarcodeGenerator(EncodeTypes.Code128))
{
    gen.SetCodeText("123ABCD", Encoding.ASCII);
    gen.Save("barcode.png", BarCodeImageFormat.Png);
}
//使用 8 位 ISO/IEC 8859-1 编码编码 1D 条形码的 codetext，缺少字节顺序标记（BOM）
using (BarcodeGenerator gen = new BarcodeGenerator(EncodeTypes.Code128))
{
    gen.SetCodeText("123ABCD", Encoding.GetEncoding(28591));
    gen.Save("barcode.png", BarCodeImageFormat.Png);
}
//使用带有字节顺序标记（BOM）的 UTF8 编码编码 2D 条形码的 codetext
using (BarcodeGenerator gen = new BarcodeGenerator(EncodeTypes.Code128))
{
    gen.SetCodeText("123ABCD", Encoding.UTF8);
    gen.Save("barcode.png", BarCodeImageFormat.Png);
}

SetCodeText(string, Encoding, bool)

使用可选的字节顺序标记（BOM）插入对 codetext 进行编码，使用指定编码（如 UTF8、UTF16、UTF32 等）。 1D 条形码应使用 Encoding.ASCII 或 ISO/IEC 8859-1 - Encoding.GetEncoding(28591)。2D 条形码应使用 Encoding.UTF8。

public void SetCodeText(string codeText, Encoding encoding, bool insertBOM)

参数

codeText string

CodeText 字符串

encoding Encoding

应用的编码

insertBOM bool

指示插入编码字节顺序标记（BOM）的标志。如果编码需要插入字节顺序标记（BOM）：如 UTF8、UTF16、UTF32 等，并且标志设置为 true，则将添加 BOM；如果将标志设置为 false，则忽略 BOM 插入。

示例

此示例演示如何使用 SetCodeText 处理 1D 和 2D 条形码

//使用 7 位 ASCII 编码编码 1D 条形码的 codetext，缺少字节顺序标记（BOM）
using (BarcodeGenerator gen = new BarcodeGenerator(EncodeTypes.Code128))
{
    gen.SetCodeText("123ABCD", Encoding.ASCII, true);
    gen.Save("barcode.png", BarCodeImageFormat.Png);
}
//使用 8 位 ISO/IEC 8859-1 编码编码 1D 条形码的 codetext，缺少字节顺序标记（BOM）
using (BarcodeGenerator gen = new BarcodeGenerator(EncodeTypes.Code128))
{
    gen.SetCodeText("123ABCD", Encoding.GetEncoding(28591), true);
    gen.Save("barcode.png", BarCodeImageFormat.Png);
}
//使用带有字节顺序标记（BOM）的 UTF8 编码编码 2D 条形码的 codetext
using (BarcodeGenerator gen = new BarcodeGenerator(EncodeTypes.Code128))
{
    gen.SetCodeText("123ABCD", Encoding.UTF8, true);
    gen.Save("barcode.png", BarCodeImageFormat.Png);
}
//使用不带字节顺序标记（BOM）的 UTF8 编码编码 2D 条形码的 codetext
using (BarcodeGenerator gen = new BarcodeGenerator(EncodeTypes.Code128))
{
    gen.SetCodeText("123ABCD", Encoding.UTF8, false);
    gen.Save("barcode.png", BarCodeImageFormat.Png);
}
 中文