PDF417RegularBarcode¶

Namespace: O2S.Components.PDF4NET.Graphics

Defines a regular PDF 417 barcode.

public class PDF417RegularBarcode : PDF417Barcode

Inheritance Object → PDFBarcode → PDF2DBarcode → PDF417Barcode → PDF417RegularBarcode

Constructors¶

PDF417RegularBarcode()¶

Initializes a new PDF417RegularBarcode object.

public PDF417RegularBarcode()

Properties¶

BackgroundColor¶

Gets or sets the barcode background color.

public PDFColor BackgroundColor { get; set; }

Property Value

PDFColor
A PDFColor that represents the color used to fill the barcode background.

BarColor¶

Gets or sets the barcode bar color.

public PDFColor BarColor { get; set; }

Property Value

PDFColor
A PDFColor that represents the color used to draw the barcode bars.

BinaryData¶

Gets or sets the binary data.

public Byte[] BinaryData { get; set; }

Property Value

Byte[]
An array of bytes representing the data to be encoded.

Columns¶

Gets or sets the barcode columns.

public int Columns { get; set; }

Property Value

Int32
The number of data columns.

Remarks

PDF 417 barcodes support 1 to 30 columns. 0 columns means that the number of columns is computed automatically.
Note: PDF417RegularBarcode.Rows and Columns cannot be both 0.

CompactionMode¶

Gets or sets the data compaction mode for this barcode.

public PDF417DataCompactionMode CompactionMode { get; set; }

Property Value

PDF417DataCompactionMode
A PDF417DataCompactionMode enumeration member specifying the data compaction mode used in this barcode.

Remarks

The Text compaction mode provides a 2:1 compaction ratio when using only ASCII characters from 0x20 to 0x7F. The Numeric compaction mode provides a 2.93:1 compaction ratio when using only digits (0x30 to 0x39). Byte compaction mode provides a 1.2:1 compaction ratio when using any 8bit character.

Data¶

Gets or sets the barcode data.

public string Data { get; set; }

Property Value

String
A string of characters that represents the data to be encoded as a barcode.

Remarks

Each barcode type specifies the characters it supports.

ErrorCorrectionLevel¶

Gets or sets the error correction level.

public PDF417ErrorCorrectionLevel ErrorCorrectionLevel { get; set; }

Property Value

PDF417ErrorCorrectionLevel
A PDF417ErrorCorrectionLevel that represents the error correction level.

Remarks

The higher the error correction level is the more resilient the barcode is. But a higher error correction level means a larger barcode.

Height¶

Gets the barcode height.

public double Height { get; }

Property Value

Double
The height of the barcode.

IsValid¶

Gets a value indicating whether a valid barcode can be built.

public bool IsValid { get; }

Property Value

Boolean
True if the barcode can be built, false otherwise.

Remarks

The following items are considered when building the barcode: barcode data, rows, columns and error correction level.

QuietZones¶

Gets the barcode quiet zones.

public PDFBarcodeQuietZones QuietZones { get; }

Property Value

PDFBarcodeQuietZones
Left, right, top and bottom quiet zones.

Rows¶

Gets or sets the barcode rows.

public int Rows { get; set; }

Property Value

Int32
The number of data rows.

Remarks

PDF 417 barcodes support 3 to 90 rows. 0 rows means that the number of rows is computed automatically.
Note: Rows and PDF417RegularBarcode.Columns cannot be both 0.

TextColor¶

Gets or sets the barcode text color.

public PDFColor TextColor { get; set; }

Property Value

PDFColor
A PDFColor that represents the color used to display the barcode text.

Width¶

Gets the barcode width.

public double Width { get; }

Property Value

Double
The width of the barcode.

XDimension¶

Gets or sets the X dimension.

public double XDimension { get; set; }

Property Value

Double
The width of a narrow barcode bar.

YDimension¶

Gets or sets the Y dimension.

public double YDimension { get; set; }

Property Value

Double
The height of a barcode bar.