Class QrWriter
Provides functionality to write QR codes.
Inheritance
Namespace: IronQr
Assembly: IronQr.dll
Syntax
public class QrWriter : ObjectQrWriter generates QR codes from text, bytes, or a stream in C#. Every member is a static Write overload, so there is nothing to construct: call QrWriter.Write(...) and a QrCode comes back, ready to save as an image, stamp onto a PDF, or export as a data URL.
The overloads cover the common inputs. Write(string) encodes text or a URL, Write(byte[]) encodes raw bytes, and Write(Stream) encodes a stream's contents. Each has a second form that also takes a QrOptions, which sets the QrEncoding, the QrErrorCorrectionLevel, the version, and the character encoding. Without options, the writer picks sensible defaults for a standard QRCode.
Encoding a byte[] or Stream suits a binary payload such as a serialized token or a small file, while Write(string) covers the common URL and text cases. Because every overload returns the same QrCode, the choice of output, an image, a PDF stamp, a data URL, or an HTML tag, is made afterward and is independent of how the code was encoded.
The result is a QrCode. From there, Save writes an image and accepts a QrStyleOptions to control size, color, margins, and an embedded logo, while StampToExistingPdfPage and StampToExistingPdfPages place the code onto a PDF, and ToDataUrl and ToHtmlTag produce web-ready output. Raise the error-correction level when the code must survive print wear or a logo overlay.
using IronQr;
QrCode qr = QrWriter.Write("https://ironsoftware.com");
qr.Save("qr.png");The generate QR code example writes a basic code, the styled QR example applies styling, and the QR writing tutorial covers the options.
Constructors
QrWriter()
Declaration
public QrWriter()Methods
Write(Byte[])
Renders a QR code from a String of data. UTF-8 fully supported.
Declaration
public static QrCode Write(byte[] binaryData)Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte[] | binaryData | The value of the QR code as a byte array. |
Returns
| Type | Description |
|---|---|
| QrCode | A QrCode object for the QR code which can be manipulated, annotated and saved to a IronSoftware.Drawing.AnyBitmap, an object, image file, PDF, MediaURL or data stream. |
Write(Byte[], QrOptions)
Renders a QR code from a String of data. UTF-8 fully supported.
Declaration
public static QrCode Write(byte[] binaryData, QrOptions options)Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte[] | binaryData | The value of the QR code as a byte array. |
| QrOptions | options | The options for customizing the QR code, including error correction level and version. |
Returns
| Type | Description |
|---|---|
| QrCode | A QrCode object for the QR code which can be manipulated, annotated and saved to a IronSoftware.Drawing.AnyBitmap, an object, image file, PDF, MediaURL or data stream. |
Write(Stream)
Renders a QR code from a String of data. UTF-8 fully supported.
Declaration
public static QrCode Write(Stream binaryDataStream)Parameters
| Type | Name | Description |
|---|---|---|
| System.IO.Stream | binaryDataStream | The value of the QR code as a stream. |
Returns
| Type | Description |
|---|---|
| QrCode | A QrCode object for the QR code which can be manipulated, annotated and saved to a IronSoftware.Drawing.AnyBitmap, an object, image file, PDF, MediaURL or data stream. |
Write(Stream, QrOptions)
Renders a QR code from a String of data. UTF-8 fully supported.
Declaration
public static QrCode Write(Stream binaryDataStream, QrOptions options)Parameters
| Type | Name | Description |
|---|---|---|
| System.IO.Stream | binaryDataStream | The value of the QR code as a stream. |
| QrOptions | options | The options for customizing the QR code, including error correction level and version. |
Returns
| Type | Description |
|---|---|
| QrCode | A QrCode object for the QR code which can be manipulated, annotated and saved to a IronSoftware.Drawing.AnyBitmap, an object, image file, PDF, MediaURL or data stream. |
Write(String)
Renders a QR code from a String of data. UTF-8 fully supported.
Declaration
public static QrCode Write(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value | The value of the QR code as a string. Also suitable for URLS. |
Returns
| Type | Description |
|---|---|
| QrCode | A QrCode object for the QR code which can be manipulated, annotated and saved to a IronSoftware.Drawing.AnyBitmap, an object, image file, PDF, MediaURL or data stream. |
Write(String, QrOptions)
Renders a QR code from a String of data. UTF-8 fully supported.
Declaration
public static QrCode Write(string value, QrOptions options)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value | The value of the QR code as a string. Also suitable for URLS. |
| QrOptions | options | The options for customizing the QR code, including error correction level and version. |
Returns
| Type | Description |
|---|---|
| QrCode | A QrCode object for the QR code which can be manipulated, annotated and saved to a IronSoftware.Drawing.AnyBitmap, an object, image file, PDF, MediaURL or data stream. |