HtmlForgeX

API Reference

Class

EmailQrCode

Namespace HtmlForgeX.Email
Assembly HtmlForgeX.Email
Base Element
Implements
Modifiers sealed

Email-safe QR code component rendered as a table grid (no images/SVG/canvas). Designed to work in legacy clients (including Outlook) using only table markup.

Inheritance

Constructors

Methods

public override String ToString() #
Returns: String
public EmailQrCode WithAlignment(Alignment alignment) #
Returns: EmailQrCode

Sets the QR block alignment.

Parameters

alignment HtmlForgeX.Email.Alignment requiredposition: 0
public EmailQrCode WithBorder(String color, String width = "1px", String radius = null) #
Returns: EmailQrCode

Sets an optional border around the QR block.

Parameters

color System.String requiredposition: 0
width System.String = "1px" optionalposition: 1
radius System.String = null optionalposition: 2
public EmailQrCode WithColors(String dark, String light) #
Returns: EmailQrCode

Sets dark and light colors.

Parameters

dark System.String requiredposition: 0
light System.String requiredposition: 1
public EmailQrCode WithErrorCorrection(EmailQrErrorCorrectionLevel level) #
Returns: EmailQrCode

Sets the error correction level.

Parameters

level HtmlForgeX.Email.EmailQrErrorCorrectionLevel requiredposition: 0
public EmailQrCode WithModuleSize(Int32 pixels) #
Returns: EmailQrCode

Sets the module size in pixels.

Parameters

pixels System.Int32 requiredposition: 0
public EmailQrCode WithQuietZone(Int32 modules) #
Returns: EmailQrCode

Sets the quiet zone size in modules.

Parameters

modules System.Int32 requiredposition: 0
public EmailQrCode WithValue(String value) #
Returns: EmailQrCode

Sets the QR payload value.

Parameters

value System.String requiredposition: 0
public EmailQrCode WithVersionRange(Int32 minVersion, Int32 maxVersion) #
Returns: EmailQrCode

Sets the allowed QR version range.

Parameters

minVersion System.Int32 requiredposition: 0
maxVersion System.Int32 requiredposition: 1

Properties

public String Value { get; set; } #

Payload encoded into the QR code (UTF-8 byte mode).

public EmailQrErrorCorrectionLevel ErrorCorrectionLevel { get; set; } #

Error correction level.

public Int32 MinVersion { get; set; } #

Minimum QR version to consider (1-40).

public Int32 MaxVersion { get; set; } #

Maximum QR version to consider (1-40). Keeping this low helps avoid very large HTML output in emails (Gmail clipping risk).

public Int32 ModuleSizePx { get; set; } #

Size of a single module in pixels.

public Int32 QuietZoneModules { get; set; } #

Quiet zone size in modules.

public String DarkColor { get; set; } #

Dark module color.

public String LightColor { get; set; } #

Light module color (background).

public String BorderColor { get; set; } #

Optional border color around the QR block (empty = none).

public String BorderWidth { get; set; } #

Optional border width (defaults to 1px when BorderColor is set).

public String BorderRadius { get; set; } #

Optional border radius around the QR block.

public Alignment Alignment { get; set; } #

Alignment of the QR block within its container.