CodeGlyphX logo
CodeGlyphX

API Reference

Class

QrCode

Edit on GitHub
Namespace CodeGlyphX
Assembly CodeGlyphX
Source CodeGlyphX/QrCode.cs:39
Modifiers sealed

A generated QR code (modules + metadata).

Inheritance

  • Object
  • QrCode

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Accepted by parameters

Constructors

public QrCode(Int32 version, QrErrorCorrectionLevel errorCorrectionLevel, Int32 mask, BitMatrix modules) #
CodeGlyphX/QrCode.cs:39

Creates a new QrCode.

Parameters

version System.Int32 requiredposition: 0
errorCorrectionLevel CodeGlyphX.QrErrorCorrectionLevel requiredposition: 1
mask System.Int32 requiredposition: 2
modules CodeGlyphX.BitMatrix requiredposition: 3

Methods

Encode 2 overloads
public static QrCode Encode(QrPayloadData payload, QrEasyOptions options = null) #
CodeGlyphX/QrCode.cs:68
Returns: QrCode

Encodes a payload into a QrCode.

Parameters

payload System.String requiredposition: 0
options CodeGlyphX.QrEasyOptions = null optionalposition: 1
Encode(CodeGlyphX.Payloads.QrPayloadData payload, CodeGlyphX.QrEasyOptions options) #

Encodes a payload with embedded defaults into a QrCode.

Parameters

payload CodeGlyphX.Payloads.QrPayloadData required
options CodeGlyphX.QrEasyOptions required
public static QrCode EncodeAuto(String payload, QrPayloadDetectOptions detectOptions = null, QrEasyOptions options = null) #
CodeGlyphX/QrCode.cs:61
Returns: QrCode

Detects a payload type and encodes it into a QrCode.

Parameters

payload System.String requiredposition: 0
detectOptions CodeGlyphX.Payloads.QrPayloadDetectOptions = null optionalposition: 1
options CodeGlyphX.QrEasyOptions = null optionalposition: 2
Render 3 overloads
public RenderedOutput Render(OutputFormat format, QrEasyOptions options = null, RenderExtras extras = null) #
CodeGlyphX/QrCode.cs:75
Returns: RenderedOutput

Renders this QR code to the requested output format.

Parameters

format CodeGlyphX.Rendering.OutputFormat requiredposition: 0
options CodeGlyphX.QrEasyOptions = null optionalposition: 1
extras CodeGlyphX.Rendering.RenderExtras = null optionalposition: 2
public static RenderedOutput Render(QrPayloadData payload, OutputFormat format, QrEasyOptions options = null, RenderExtras extras = null) #
CodeGlyphX/QrCode.cs:98
Returns: RenderedOutput

Renders a payload to the requested output format.

Parameters

payload System.String requiredposition: 0
format CodeGlyphX.Rendering.OutputFormat requiredposition: 1
options CodeGlyphX.QrEasyOptions = null optionalposition: 2
extras CodeGlyphX.Rendering.RenderExtras = null optionalposition: 3
Render(CodeGlyphX.Payloads.QrPayloadData payload, CodeGlyphX.Rendering.OutputFormat format, CodeGlyphX.QrEasyOptions options, CodeGlyphX.Rendering.RenderExtras extras) #

Renders a payload with embedded defaults to the requested output format.

Parameters

payload CodeGlyphX.Payloads.QrPayloadData required
format CodeGlyphX.Rendering.OutputFormat required
options CodeGlyphX.QrEasyOptions required
extras CodeGlyphX.Rendering.RenderExtras required
public static RenderedOutput RenderAuto(String payload, OutputFormat format, QrPayloadDetectOptions detectOptions = null, QrEasyOptions options = null, RenderExtras extras = null) #
CodeGlyphX/QrCode.cs:90
Returns: RenderedOutput

Detects a payload type and renders a QR code.

Parameters

payload System.String requiredposition: 0
format CodeGlyphX.Rendering.OutputFormat requiredposition: 1
detectOptions CodeGlyphX.Payloads.QrPayloadDetectOptions = null optionalposition: 2
options CodeGlyphX.QrEasyOptions = null optionalposition: 3
extras CodeGlyphX.Rendering.RenderExtras = null optionalposition: 4
Save 6 overloads
public String Save(String path, QrEasyOptions options = null, RenderExtras extras = null) #
CodeGlyphX/QrCode.cs:106
Returns: String

Saves this QR code to a file, choosing the output format based on file extension.

Parameters

path System.String requiredposition: 0
options CodeGlyphX.QrEasyOptions = null optionalposition: 1
extras CodeGlyphX.Rendering.RenderExtras = null optionalposition: 2
public static String Save(QrPayloadData payload, String path, QrEasyOptions options = null, RenderExtras extras = null) #
CodeGlyphX/QrCode.cs:151
Returns: String

Saves this QR code to a stream in the specified format.

Parameters

format CodeGlyphX.Rendering.OutputFormat requiredposition: 0
stream System.IO.Stream requiredposition: 1
options CodeGlyphX.QrEasyOptions = null optionalposition: 2
extras CodeGlyphX.Rendering.RenderExtras = null optionalposition: 3
Save(System.String payload, System.String path, CodeGlyphX.QrEasyOptions options, System.String title) #

Saves a payload to a file, choosing the output format based on file extension.

Parameters

payload System.String required
path System.String required
options CodeGlyphX.QrEasyOptions required
title System.String required
Save(System.String payload, System.String path, CodeGlyphX.QrEasyOptions options, CodeGlyphX.Rendering.RenderExtras extras) #

Saves a payload to a file, choosing the output format based on file extension.

Parameters

payload System.String required
path System.String required
options CodeGlyphX.QrEasyOptions required
extras CodeGlyphX.Rendering.RenderExtras required
Save(CodeGlyphX.Payloads.QrPayloadData payload, System.String path, CodeGlyphX.QrEasyOptions options, System.String title) #

Saves a payload with embedded defaults to a file, choosing the output format based on file extension.

Parameters

payload CodeGlyphX.Payloads.QrPayloadData required
path System.String required
options CodeGlyphX.QrEasyOptions required
title System.String required
Save(CodeGlyphX.Payloads.QrPayloadData payload, System.String path, CodeGlyphX.QrEasyOptions options, CodeGlyphX.Rendering.RenderExtras extras) #

Saves a payload with embedded defaults to a file, choosing the output format based on file extension.

Parameters

payload CodeGlyphX.Payloads.QrPayloadData required
path System.String required
options CodeGlyphX.QrEasyOptions required
extras CodeGlyphX.Rendering.RenderExtras required

Properties

public Int32 Version { get; } #
CodeGlyphX/QrCode.cs:14

Gets the QR version (1..40).

public QrErrorCorrectionLevel ErrorCorrectionLevel { get; } #
CodeGlyphX/QrCode.cs:19

Gets the error correction level used for encoding.

public Int32 Mask { get; } #
CodeGlyphX/QrCode.cs:24

Gets the selected mask pattern (0..7).

public BitMatrix Modules { get; } #
CodeGlyphX/QrCode.cs:29

Gets the QR modules (dark = true, light = false), without quiet zone.

public Int32 Size { get; } #
CodeGlyphX/QrCode.cs:34

Gets the module matrix size (width/height), i.e. Version * 4 + 17.