Class QrEncodeOptions

Namespace

TwBlazor.Services.Encoding

Assembly

TwBlazor.dll

Settings that control how data is encoded into a QrMatrix.

public sealed record QrEncodeOptions : IEquatable<QrEncodeOptions>

Inheritance

object

QrEncodeOptions

Implements

IEquatable<QrEncodeOptions>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

QrEncodeOptions()

public QrEncodeOptions()

Properties

BoostErrorCorrection

Gets whether to raise the error correction level when that does not make the code any larger. Defaults to true: the extra robustness is free.

public bool BoostErrorCorrection { get; init; }

Property Value

bool

Default

Gets the shared default options: Medium with boosting on.

public static QrEncodeOptions Default { get; }

Property Value

QrEncodeOptions

ErrorCorrection

Gets the minimum error correction level. Defaults to Medium.

public QrErrorCorrection ErrorCorrection { get; init; }

Property Value

QrErrorCorrection

Mask

Gets the mask pattern to apply, from 0 to 7, or null (the default) to pick the one that is easiest to scan.

public int? Mask { get; init; }

Property Value

int?

MaxVersion

Gets the largest version to use, from 1 to 40. Defaults to 40.

public int MaxVersion { get; init; }

Property Value

int

MinVersion

Gets the smallest version to use, from 1 to 40. Defaults to 1. Raise it to keep codes the same size while their content changes.

public int MinVersion { get; init; }

Property Value

int

Methods

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

Equals(QrEncodeOptions?)

public bool Equals(QrEncodeOptions? other)

Parameters

other QrEncodeOptions

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

Operators

operator ==(QrEncodeOptions?, QrEncodeOptions?)

public static bool operator ==(QrEncodeOptions? left, QrEncodeOptions? right)

Parameters

left QrEncodeOptions

right QrEncodeOptions

Returns

bool

operator !=(QrEncodeOptions?, QrEncodeOptions?)

public static bool operator !=(QrEncodeOptions? left, QrEncodeOptions? right)

Parameters

left QrEncodeOptions

right QrEncodeOptions

Returns

bool