Class QrOptions

Namespace

Egami.Barcodes

Assembly

Egami.Barcodes.dll

How Qr(string, QrOptions?) makes a symbol; every unset property is chosen automatically.

public sealed record QrOptions : IEquatable<QrOptions>

Inheritance

object

QrOptions

Implements

IEquatable<QrOptions>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Examples

// Level M, raised to Q or H when that fits in the same size; segments chosen for the fewest bits.
Barcode link = Barcode.Qr("https://inexin.github.io/Egami/");

// A fixed size and level, for a layout that must not change.
Barcode fixedSize = Barcode.Qr("ORDER-1180042", new QrOptions { Version = 3, ErrorCorrection = QrErrorCorrection.H });

// Bytes as they are, and GS1 element strings with FNC1.
Barcode bytes = Barcode.Qr([0x45, 0x67, 0x61, 0x6D, 0x69]);
Barcode gs1 = Barcode.Qr(Gs1.Parse("(01)09501101530003(10)AB12"));

using Raster<Gray8> image = link.ToRaster(pixelsPerModule: 4);

Properties

Default

Gets the defaults.

public static QrOptions Default { get; }

Property Value

QrOptions

ErrorCorrection

Gets the error correction level, or null, the default, for level M raised to Q or H while the symbol stays the same size.

public QrErrorCorrection? ErrorCorrection { get; init; }

Property Value

QrErrorCorrection?

Mask

Gets the mask pattern, 0 to 7, or null, the default, for the one with the lowest penalty score.

public int? Mask { get; init; }

Property Value

int?

Exceptions

ArgumentOutOfRangeException

The value is not 0 to 7.

Version

Gets the version, 1 (21 x 21 modules) to 40 (177 x 177), or null, the default, for the smallest that fits.

public int? Version { get; init; }

Property Value

int?

Exceptions

ArgumentOutOfRangeException

The value is not 1 to 40.