Class QrResult

Represents the result of a QR code detection.

Inheritance
System.Object
QrResult
Namespace: IronQr
Assembly: IronQr.dll
Syntax
public class QrResult : Object

QrResult is one decoded QR code returned by QrReader.Read. A read produces an IEnumerable<QrResult>, one entry per code found in the image, and each result holds everything detected about that code.

Value is the decoded text, the field most reads need. Url is the same payload parsed as a Uri when the value is a link, saving a manual parse. QrType reports the detected QrEncoding, distinguishing a standard QRCode from a MicroQRCode or RMQRCode. Points gives the corner coordinates that locate the code in the source image, which a scanner UI can use to draw a highlight. The text and type fields are read-only, reflecting a single detection. Reading Points lets an application mark exactly where each code was found, which matters when several codes share one frame and the user needs to know which highlighted region maps to which decoded value.

foreach (QrResult result in reader.Read(input))
    Console.WriteLine(result.Value);

The read QR value example reads the decoded text, and the read QR type how-to inspects the encoding.

Constructors

QrResult(PointF[], String)

Initializes a new instance of the QrResult class.

Declaration
public QrResult(PointF[] points, string value)
Parameters
Type Name Description
IronSoftware.Drawing.PointF[] points

Points defining the corners of the detected QR code.
System.String value

Decoded value of the detected QR code.

QrResult(PointF[], String, QrEncoding)

Initializes a new instance of the QrResult class.

Declaration
public QrResult(PointF[] points, string value, QrEncoding qrType)
Parameters
Type Name Description
IronSoftware.Drawing.PointF[] points

Points defining the corners of the detected QR code.
System.String value

Decoded value of the detected QR code.
QrEncoding qrType

Encoding type of the detected QR code.

Fields

Points

Points defining the corners of the detected QR code.

Declaration
public readonly PointF[] Points
Field Value
Type Description
IronSoftware.Drawing.PointF[]

QrType

Type of encoding of the QR code (either QRCode, MicroQRCode, or RMQRCode).

Declaration
public readonly QrEncoding QrType
Field Value
Type Description
QrEncoding

Value

Decoded value of the detected QR code.

Declaration
public readonly string Value
Field Value
Type Description
System.String

Properties

Url

Gets the URI if the Value is a valid URI.

Declaration
public Uri Url { get; }
Property Value
Type Description
System.Uri