Class QRCodeWriter
A class allowing for advanced control on the generation of QR type barcodes.
QRCodeWriter gives the developer access to set QR code error correction levels, and to add logo images to QR codes.
Generated Barcodes can be exported as Images, Bitmaps, Files and Streams.
Inheritance
Namespace: IronBarCode
Assembly: IronBarCode.dll
Syntax
public static class QRCodeWriter : ObjectMethods
CreateQrCode(Byte[], Int32, QRCodeWriter.QrErrorCorrectionLevel, Int32)
Renders a QR code.
Overload methods and methods of the created GeneratedBarcode object allow for barcode sizes and colors to be customized. Logos & Branding may also be added using the CreateQrCodeWithLogo method.
Declaration
public static GeneratedBarcode CreateQrCode(byte[] BinaryData, int Size = 500, QRCodeWriter.QrErrorCorrectionLevel ErrorCorrection, int QrVersion = 0)Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte[] | BinaryData | The value of the QR code as a byte array. |
| System.Int32 | Size | The width and height of the QR code in pixels. |
| QRCodeWriter.QrErrorCorrectionLevel | ErrorCorrection | The error correction level of the QR code. |
| System.Int32 | QrVersion | The symbol version of the QR Code from 1-40. The default value 0 will automatticaly assign an appropriate QrVersion for your data (highly reccomended). Higher QrVersion numbers generate a more complex graphic and can encode more data. Lower QrVersion numbers generate simpler QR codes that may be more readable at a distance. If you decide to set a very low QrVersion, you may experience an IronBarCodeEncodingException if the size of data you are encoding exceeds the limits of that symbol version. Please read https://www.qrcode.com/en/about/version.html |
Returns
| Type | Description |
|---|---|
| GeneratedBarcode | A GeneratedBarcode object for the QR code which can be manipulated, annotated and saved to a System.Drawing.Image, an object, image file, PDF, MediaURL or data stream. |
CreateQrCode(Stream, Int32, QRCodeWriter.QrErrorCorrectionLevel, Int32)
Renders a QR code.
Overload methods and methods of the created GeneratedBarcode object allow for barcode sizes and colors to be customized. Logos & Branding may also be added using the CreateQrCodeWithLogo method.
Declaration
public static GeneratedBarcode CreateQrCode(Stream BinaryDataStream, int Size = 500, QRCodeWriter.QrErrorCorrectionLevel ErrorCorrection, int QrVersion = 0)Parameters
| Type | Name | Description |
|---|---|---|
| System.IO.Stream | BinaryDataStream | The value of the QR code as a stream. |
| System.Int32 | Size | The width and height of the QR code in pixels. |
| QRCodeWriter.QrErrorCorrectionLevel | ErrorCorrection | The error correction level of the QR code. |
| System.Int32 | QrVersion | The symbol version of the QR Code from 1-40. The default value 0 will automatticaly assign an appropriate QrVersion for your data (highly reccomended). Higher QrVersion numbers generate a more complex graphic and can encode more data. Lower QrVersion numbers generate simpler QR codes that may be more readable at a distance. If you decide to set a very low QrVersion, you may experience an IronBarCodeEncodingException if the size of data you are encoding exceeds the limits of that symbol version. Please read https://www.qrcode.com/en/about/version.html |
Returns
| Type | Description |
|---|---|
| GeneratedBarcode | A GeneratedBarcode object for the QR code which can be manipulated, annotated and saved to a System.Drawing.Image, an object, image file, PDF, MediaURL or data stream. |
CreateQrCode(String, Int32, QRCodeWriter.QrErrorCorrectionLevel, Int32)
Renders a QR code from a String of data. UTF-8 fully supported.
Overload methods and methods of the created GeneratedBarcode object allow for barcode sizes and colors to be customized. Logos / Branding may also be added.
Declaration
public static GeneratedBarcode CreateQrCode(string Value, int Size = 500, QRCodeWriter.QrErrorCorrectionLevel ErrorCorrection, int QrVersion = 0)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Value | The value of the QR code as a string. Also suitable for URLS. |
| System.Int32 | Size | The width and height of the QR code in pixels. |
| QRCodeWriter.QrErrorCorrectionLevel | ErrorCorrection | The error correction level of the QR code. |
| System.Int32 | QrVersion | The symbol version of the QR Code from 1-40. The default value 0 will automatticaly assign an appropriate QrVersion for your data (highly reccomended). Higher QrVersion numbers generate a more complex graphic and can encode more data. Lower QrVersion numbers generate simpler QR codes that may be more readable at a distance. If you decide to set a very low QrVersion, you may experience an IronBarCodeEncodingException if the size of data you are encoding exceeds the limits of that symbol version. Please read https://www.qrcode.com/en/about/version.html |
Returns
| Type | Description |
|---|---|
| GeneratedBarcode | A GeneratedBarcode object for the QR code which can be manipulated, annotated and saved to a System.Drawing.Image, an object, image file, PDF, MediaURL or data stream. |
CreateQrCodeWithLogo(Byte[], QRCodeLogo, Int32, Int32)
Renders a QR code of given dimensions with a logo image at its center.
Declaration
public static GeneratedBarcode CreateQrCodeWithLogo(byte[] BinaryData, QRCodeLogo QRCodeLogo, int Size = 500, int QrVersion = 0)Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte[] | BinaryData | The value of the QR code as a byte array. |
| QRCodeLogo | QRCodeLogo | A QRCodeLogo class instance representing your desired logo image settings. |
| System.Int32 | Size | The width and height of the QR code in pixels. |
| System.Int32 | QrVersion | The symbol version of the QR Code from 1-40. The default value 0 will automatticaly assign an appropriate QrVersion for your data (highly reccomended). Higher QrVersion numbers generate a more complex graphic and can encode more data. Lower QrVersion numbers generate simpler QR codes that may be more readable at a distance. If you decide to set a very low QrVersion, you may experience an IronBarCodeEncodingException if the size of data you are encoding exceeds the limits of that symbol version. Please read https://www.qrcode.com/en/about/version.html |
Returns
| Type | Description |
|---|---|
| GeneratedBarcode | A GeneratedBarcode object for the QR code which can be manipulated, annotated and saved to a System.Drawing.Image, an object, image file, PDF, MediaURL or data stream. |
CreateQrCodeWithLogo(Stream, QRCodeLogo, Int32, Int32)
Renders a QR code of given dimensions with a logo image at its center.
Declaration
public static GeneratedBarcode CreateQrCodeWithLogo(Stream BinaryDataStream, QRCodeLogo QRCodeLogo, int Size = 500, int QrVersion = 0)Parameters
| Type | Name | Description |
|---|---|---|
| System.IO.Stream | BinaryDataStream | The value of the QR code as a stream. |
| QRCodeLogo | QRCodeLogo | A QRCodeLogo class instance representing your desired logo image settings. |
| System.Int32 | Size | The width and height of the QR code in pixels. |
| System.Int32 | QrVersion | The symbol version of the QR Code from 1-40. The default value 0 will automatticaly assign an appropriate QrVersion for your data (highly reccomended). Higher QrVersion numbers generate a more complex graphic and can encode more data. Lower QrVersion numbers generate simpler QR codes that may be more readable at a distance. If you decide to set a very low QrVersion, you may experience an IronBarCodeEncodingException if the size of data you are encoding exceeds the limits of that symbol version. Please read https://www.qrcode.com/en/about/version.html |
Returns
| Type | Description |
|---|---|
| GeneratedBarcode | A GeneratedBarcode object for the QR code which can be manipulated, annotated and saved to a System.Drawing.Image, an object, image file, PDF, MediaURL or data stream. |
CreateQrCodeWithLogo(String, QRCodeLogo, Int32, Int32)
Renders a QR code of given dimensions with a logo image at its center.
Declaration
public static GeneratedBarcode CreateQrCodeWithLogo(string Value, QRCodeLogo QRCodeLogo, int Size = 500, int QrVersion = 0)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Value | The value of the QR code as a string. Also suitable for URLS. |
| QRCodeLogo | QRCodeLogo | A QRCodeLogo class instance representing your desired logo image settings. |
| System.Int32 | Size | The width and height of the QR code in pixels. |
| System.Int32 | QrVersion | The symbol version of the QR Code from 1-40. The default value 0 will automatticaly assign an appropriate QrVersion for your data (highly reccomended). Higher QrVersion numbers generate a more complex graphic and can encode more data. Lower QrVersion numbers generate simpler QR codes that may be more readable at a distance. If you decide to set a very low QrVersion, you may experience an IronBarCodeEncodingException if the size of data you are encoding exceeds the limits of that symbol version. Please read https://www.qrcode.com/en/about/version.html |
Returns
| Type | Description |
|---|---|
| GeneratedBarcode | A GeneratedBarcode object for the QR code which can be manipulated, annotated and saved to a System.Drawing.Image, an object, image file, PDF, MediaURL or data stream. |