Link Search Menu Expand Document

QRCode Class

Represents QR Code barcode generator.
Inheritance Hierarchy
SystemObject
Bytescout.BarCodeQRCode

Namespace:Bytescout.BarCode
Assembly: Bytescout.BarCode.QRCode (in Bytescout.BarCode.QRCode.dll) Version: 1.7.1.1185-master
Syntax
public class QRCode : IDisposable

The QRCode type exposes the following members.

Constructors
NameDescription
Public methodQRCode
Initializes a new instance of the QRCode class.
Public methodQRCode(String, String)
Initializes and activates a new instance of the QRCode class.
Top
Properties
NameDescription
Public propertyAdditionalCaption
Gets or sets the additional barcode caption text to draw.
Public propertyAdditionalCaptionFont
Gets or sets the additional barcode caption font.
Public propertyAdditionalCaptionPosition
Gets or sets the barcode additional caption position.
Public propertyBackColor
Gets or sets the color used to draw the barcode background.
Public propertyCaption
Gets or sets the barcode caption (by default this is encoded value).
Public propertyCaptionFont
Gets or sets the barcode caption font.
Public propertyCaptionPosition
Gets or sets the barcode caption position.
Public propertyCharacterEncoding
Gets or sets the character encoding of barcode value. Default is Default - the default encoding on your computer.
Public propertyDotSize
Gets or sets the size of QR Code dot in pixels.
Public propertyDrawCaption
Gets or sets a value indicating whether to draw the barcode value.
Public propertyDrawQuietZones
Gets or sets a value indicating whether to draw quite zones when drawing symbologies that have such zones.
Public propertyForeColor
Gets or sets the color used to draw the barcode bars and caption(s).
Public propertyIsGS1
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".
Public propertyMargins
Gets or sets the barcode margins.
Public propertyProduceMonochromeImages
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.
Public propertyQROption_EncodingHint
Gets or sets the QR Code-specific hint to use when encoding non-alphanumeric data.
Public propertyQROption_ErrorCorrectionLevel
Gets or sets the error correction level for QR Code barcodes.
Public propertyQROption_Version
Gets or sets the minimum version (size) for QR Code barcodes.
Public propertyRegistrationKey
Gets or sets the key part of the registration information.
Public propertyRegistrationName
Gets or sets the name part of the registration information.
Public propertyValue
Gets or sets the barcode value to encode.
Public propertyVersion
Gets the component version number.
Top
Methods
NameDescription
Public methodAddDecorationImage(Image, Int32)
Adds decorative image to draw in the center of the QR Code.
Public methodAddDecorationImage(String, Int32)
Adds decorative image to draw in the center of the QR Code.
Public methodDispose
Releases all resources used by the QRCode
Public methodDrawOnGraphics
Draws the barcode on Graphics canvas object.
Public methodDrawOnHDC
Draws the barcode on HDC canvas object.
Public methodDrawToImage(Stream, Int32, Int32, Int32, Stream)
Draws barcode on another image at specified coordinates.
Public methodDrawToImage(String, Int32, Int32, Int32, String)
Draws barcode on another image at specified coordinates.
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetImage
Gets the Image object with the barcode.
Public methodGetImageBytes
Gets the bytes of the bitmap with the barcode.
Public methodGetImageBytesEMF
Gets the bytes of the EMF image with the barcode.
Public methodGetImageBytesGIF
Gets the bytes of the GIF image with the barcode.
Public methodGetImageBytesJPG
Gets the bytes of the JPG image with the barcode.
Public methodGetImageBytesPNG
Gets the bytes of the PNG image with the barcode.
Public methodGetImageBytesTIFF
Gets the bytes of the TIFF image with the barcode.
Public methodGetMinimalSize
Gets or sets the dimension of the smallest square in pixels that can accommodate the barcode.
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodProcessMacros
Replaces macro codes with corresponding ASCII control characters.
Public methodSaveImage(Stream)
Saves the bitmap with the barcode into given stream.
Public methodSaveImage(String)
Saves the barcode image to file. Image format is selected by the file name extension.
Public methodSaveImage(Stream, ImageFormat)
Saves the image with the barcode into given stream.
Public methodSaveImage(String, ImageFormat)
Saves the barcode image to file.
Public methodSetAdditionalCaptionFont(String, Int32)
Sets the font with specified properties as the barcode additional caption font.
Public methodSetAdditionalCaptionFont(String, Int32, Boolean, Boolean, Boolean, Boolean, Byte)
Sets the font with specified properties as the barcode additional caption font.
Public methodSetBackColor
Sets background color in RGB format.
Public methodSetCaptionFont(String, Int32)
Sets the font with specified properties as the barcode caption font.
Public methodSetCaptionFont(String, Int32, Boolean, Boolean, Boolean, Boolean, Byte)
Sets the font with specified properties as the barcode caption font.
Public methodSetCharacterEncoding
Sets the character encoding of barcode value. Default is Default - the default encoding on your computer. You may override this value like:
barcode.Options.TextEncodingCodePage = 1250; // to use German locale to decode text
Some of available code pages are listed below for your reference:
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)
Public methodSetForeColor
Sets fore color in RGB format.
Public methodSetMargins
Sets the barcode margins in pixels.
Public methodToString (Inherited from Object.)
Public methodValueIsValidGS1
Validates the value against GS1 rules.
Top
See Also

Reference


Copyright © 2016 - 2021 ByteScout