QRCode Class

ByteScout QR Code SDK

Free Trial Web API version Licensing Request A Quote

HAVE QUESTIONS OR NEED HELP? SUBMIT THE SUPPORT REQUEST FORM or write email to SUPPORT@BYTESCOUT.COM

Represents QR Code barcode generator.

Inheritance Hierarchy

SystemObject
Bytescout.BarCodeQRCode

Namespace: Bytescout.BarCode
Assembly: Bytescout.BarCode.QRCode (in Bytescout.BarCode.QRCode.dll) Version: 2.0.2.1237-master

Syntax

C++

Copy

public class QRCode : IDisposable

Public Class QRCode
	Implements IDisposable

public ref class QRCode : IDisposable

type QRCode =  
    class
        interface IDisposable
    end

The QRCode type exposes the following members.

Constructors

	Name	Description
	QRCode	Initializes a new instance of the QRCode class.
	QRCode(String, String)	Initializes and activates a new instance of the QRCode class.

Top

Properties

	Name	Description
	AdditionalCaption	Gets or sets the additional barcode caption text to draw.
	AdditionalCaptionFont	Gets or sets the additional barcode caption font.
	AdditionalCaptionPosition	Gets or sets the barcode additional caption position.
	BackColor	Gets or sets the color used to draw the barcode background.
	Caption	Gets or sets the barcode caption (by default this is encoded value).
	CaptionFont	Gets or sets the barcode caption font.
	CaptionPosition	Gets or sets the barcode caption position.
	CharacterEncoding	Gets or sets the character encoding of barcode value. Default is Default - the default encoding on your computer.
	DotSize	Gets or sets the size of QR Code dot in pixels.
	DrawCaption	Gets or sets a value indicating whether to draw the barcode value.
	DrawQuietZones	Gets or sets a value indicating whether to draw quite zones when drawing symbologies that have such zones.
	ForeColor	Gets or sets the color used to draw the barcode bars and caption(s).
	IsGS1	Gets or sets whether to generate GS1 version of QR code. GS1 QR Code requires a value that is formatted according to GS1 specification. For example: "(01)07046261398572(17)130331(10)TEST5632(21)19067811811".
	Margins	Gets or sets the barcode margins.
	ProduceMonochromeImages	Gets or sets a value indicating whether the component should produce monochrome (1-bit, black and white) images. Remarks Note: 1-bit monochrome images can be created only in BMP, PNG and TIFF image formats.
	QROption_EncodingHint	Gets or sets the QR Code-specific hint to use when encoding non-alphanumeric data.
	QROption_ErrorCorrectionLevel	Gets or sets the error correction level for QR Code barcodes.
	QROption_Version	Gets or sets the minimum version (size) for QR Code barcodes.
	RegistrationKey	Gets or sets the key part of the registration information.
	RegistrationName	Gets or sets the name part of the registration information.
	Value	Gets or sets the barcode value to encode.
	Version	Gets the component version number.

Top

Methods

	Name	Description
	AddDecorationImage(Image, Int32)	Adds decorative image to draw in the center of the QR Code.
	AddDecorationImage(String, Int32)	Adds decorative image to draw in the center of the QR Code.
	Dispose	Releases all resources used by the QRCode
	DrawOnGraphics	Draws the barcode on Graphics canvas object.
	DrawOnHDC	Draws the barcode on HDC canvas object.
	DrawToImage(Stream, Int32, Int32, Int32, Stream)	Draws barcode on another image at specified coordinates.
	DrawToImage(String, Int32, Int32, Int32, String)	Draws barcode on another image at specified coordinates.
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetImage	Gets the Image object with the barcode.
	GetImageBytes	Gets the bytes of the bitmap with the barcode.
	GetImageBytesEMF	Gets the bytes of the EMF image with the barcode.
	GetImageBytesGIF	Gets the bytes of the GIF image with the barcode.
	GetImageBytesJPG	Gets the bytes of the JPG image with the barcode.
	GetImageBytesPNG	Gets the bytes of the PNG image with the barcode.
	GetImageBytesTIFF	Gets the bytes of the TIFF image with the barcode.
	GetMinimalSize	Gets or sets the dimension of the smallest square in pixels that can accommodate the barcode.
	GetType	(Inherited from Object.)
	MemberwiseClone	(Inherited from Object.)
	ProcessMacros	Replaces macro codes with corresponding ASCII control characters.
	SaveImage(Stream)	Saves the bitmap with the barcode into given stream.
	SaveImage(String)	Saves the barcode image to file. Image format is selected by the file name extension.
	SaveImage(Stream, ImageFormat)	Saves the image with the barcode into given stream.
	SaveImage(String, ImageFormat)	Saves the barcode image to file.
	SetAdditionalCaptionFont(String, Int32)	Sets the font with specified properties as the barcode additional caption font.
	SetAdditionalCaptionFont(String, Int32, Boolean, Boolean, Boolean, Boolean, Byte)	Sets the font with specified properties as the barcode additional caption font.
	SetBackColor	Sets background color in RGB format.
	SetCaptionFont(String, Int32)	Sets the font with specified properties as the barcode caption font.
	SetCaptionFont(String, Int32, Boolean, Boolean, Boolean, Boolean, Byte)	Sets the font with specified properties as the barcode caption font.
	SetCharacterEncoding	Sets the character encoding of barcode value. Default is Default - the default encoding on your computer. You may override this value like: Copy barcode.Options.TextEncodingCodePage = 1250; // to use German locale to decode text Some of available code pages are listed below for your reference: Copy Name CodePage EncodingName shift_jis 932 Japanese (Shift-JIS) windows-1250 1250 Central European (Windows) windows-1251 1251 Cyrillic (Windows) Windows-1252 1252 Western European (Windows) windows-1253 1253 Greek (Windows) windows-1254 1254 Turkish (Windows) csISO2022JP 50221 Japanese (JIS-Allow 1 byte Kana) iso-2022-kr 50225 Korean (ISO)
	SetForeColor	Sets fore color in RGB format.
	SetMargins	Sets the barcode margins in pixels.
	ToString	(Inherited from Object.)
	ValueIsValidGS1	Validates the value against GS1 rules.

Top

Reference

Bytescout.BarCode Namespace