API Reference
Class
QrBuilder
Fluent QR builder.
Inheritance
- Object
- QrBuilder
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
- Method QR.Create
- Method QrBuilder.WithBackground
- Method QrBuilder.WithBackgroundGradient
- Method QrBuilder.WithCanvas
- Method QrBuilder.WithColors
- Method QrBuilder.WithErrorCorrection
- Method QrBuilder.WithEyes
- Method QrBuilder.WithFixedSize
- Method QrBuilder.WithForeground
- Method QrBuilder.WithForegroundGradient
- Method QrBuilder.WithForegroundPalette
- Method QrBuilder.WithForegroundPaletteZones
- Method QrBuilder.WithIcoPreserveAspectRatio
- Method QrBuilder.WithIcoSizes
- Method QrBuilder.WithLogoBackground
- Method QrBuilder.WithLogoBackgroundAutoBump
- Method QrBuilder.WithLogoBackgroundColor
- Method QrBuilder.WithLogoBackgroundMinVersion
- Method QrBuilder.WithLogoCornerRadiusPx
- Method QrBuilder.WithLogoFile
- Method QrBuilder.WithLogoPaddingPx
- Method QrBuilder.WithLogoPng
- Method QrBuilder.WithLogoScale
- Method QrBuilder.WithModuleCornerRadiusPx
- Method QrBuilder.WithModuleJitter
- Method QrBuilder.WithModuleScale
- Method QrBuilder.WithModuleScaleMap
- Method QrBuilder.WithModuleShape
- Method QrBuilder.WithModuleShapeMap
- Method QrBuilder.WithModuleSize
- Method QrBuilder.WithOptions
- Method QrBuilder.WithQuietZone
- Method QrBuilder.WithStyle
- Method QrBuilder.WithTargetSize
- Method QrBuilder.WithTransparentBackground
Methods
public String Ascii(MatrixAsciiRenderOptions asciiOptions = null) #Returns:
StringRenders ASCII text.
Parameters
- asciiOptions CodeGlyphX.Rendering.Ascii.MatrixAsciiRenderOptions = null
public String AsciiConsole(AsciiConsoleOptions consoleOptions = null) #Returns:
StringRenders console-friendly ASCII text with auto-fit.
Parameters
- consoleOptions CodeGlyphX.Rendering.Ascii.AsciiConsoleOptions = null
public String Eps(RenderMode mode = Vector) #Returns:
StringRenders EPS text.
Parameters
- mode CodeGlyphX.Rendering.RenderMode = Vector
- Vector or raster output.
public Byte[] Pdf(RenderMode mode = Vector) #Returns:
Byte[]Renders PDF bytes.
Parameters
- mode CodeGlyphX.Rendering.RenderMode = Vector
- Vector or raster output.
public String Save(String path, String title = null) #Returns:
StringSaves based on file extension (.png/.svg/.svgz/.html/.jpg/.bmp/.ppm/.pbm/.pgm/.pam/.xbm/.xpm/.tga/.ico/.pdf/.eps). Defaults to PNG when no extension is provided.
Parameters
- path System.String
- title System.String = null
public String SaveAscii(String path, MatrixAsciiRenderOptions asciiOptions = null) #Returns:
StringSaves ASCII to a file.
Parameters
- path System.String
- asciiOptions CodeGlyphX.Rendering.Ascii.MatrixAsciiRenderOptions = null
public String SaveAsciiConsole(String path, AsciiConsoleOptions consoleOptions = null) #Returns:
StringSaves console-friendly ASCII to a file.
Parameters
- path System.String
- consoleOptions CodeGlyphX.Rendering.Ascii.AsciiConsoleOptions = null
SaveBmp 2 overloads
SaveEps 2 overloads
public Void SaveEps(Stream stream, RenderMode mode = Vector) #Returns:
VoidSaves EPS to a file.
Parameters
- path System.String
- Output file path.
- mode CodeGlyphX.Rendering.RenderMode = Vector
- Vector or raster output.
SaveEps(System.IO.Stream stream, CodeGlyphX.Rendering.RenderMode mode) #Saves EPS to a stream.
Parameters
- stream System.IO.Stream
- Destination stream.
- mode CodeGlyphX.Rendering.RenderMode
- Vector or raster output.
SaveHtml 2 overloads
SaveIco 2 overloads
SaveJpeg 2 overloads
SavePam 2 overloads
SavePbm 2 overloads
SavePdf 2 overloads
public Void SavePdf(Stream stream, RenderMode mode = Vector) #Returns:
VoidSaves PDF to a file.
Parameters
- path System.String
- Output file path.
- mode CodeGlyphX.Rendering.RenderMode = Vector
- Vector or raster output.
SavePdf(System.IO.Stream stream, CodeGlyphX.Rendering.RenderMode mode) #Saves PDF to a stream.
Parameters
- stream System.IO.Stream
- Destination stream.
- mode CodeGlyphX.Rendering.RenderMode
- Vector or raster output.
SavePgm 2 overloads
SavePng 2 overloads
SavePpm 2 overloads
SaveSvg 2 overloads
SaveSvgz 2 overloads
SaveTga 2 overloads
SaveWebp 2 overloads
SaveXbm 2 overloads
SaveXpm 2 overloads
public QrBuilder WithBackground(Rgba32 color) #Returns:
QrBuilderSets background color.
Parameters
- color CodeGlyphX.Rendering.Png.Rgba32
public QrBuilder WithBackgroundGradient(QrPngGradientOptions gradient) #Returns:
QrBuilderSets the background gradient.
Parameters
- gradient CodeGlyphX.Rendering.Png.QrPngGradientOptions
public QrBuilder WithCanvas(QrPngCanvasOptions canvas) #Returns:
QrBuilderSets the canvas options.
Parameters
- canvas CodeGlyphX.Rendering.Png.QrPngCanvasOptions
public QrBuilder WithColors(Rgba32 foreground, Rgba32 background) #Returns:
QrBuilderSets foreground and background colors.
Parameters
- foreground CodeGlyphX.Rendering.Png.Rgba32
- background CodeGlyphX.Rendering.Png.Rgba32
public QrBuilder WithErrorCorrection(QrErrorCorrectionLevel ecc) #Returns:
QrBuilderSets error correction level.
Parameters
- ecc CodeGlyphX.QrErrorCorrectionLevel
public QrBuilder WithEyes(QrPngEyeOptions eyes) #Returns:
QrBuilderSets eye (finder) styling.
Parameters
- eyes CodeGlyphX.Rendering.Png.QrPngEyeOptions
public QrBuilder WithFixedSize(Int32 sizePx, Boolean includeQuietZone = true) #Returns:
QrBuilderSets a fixed target size (in pixels). Module size is adjusted to fit.
Parameters
- sizePx System.Int32
- includeQuietZone System.Boolean = true
public QrBuilder WithForeground(Rgba32 color) #Returns:
QrBuilderSets foreground color.
Parameters
- color CodeGlyphX.Rendering.Png.Rgba32
public QrBuilder WithForegroundGradient(QrPngGradientOptions gradient) #Returns:
QrBuilderSets the foreground gradient.
Parameters
- gradient CodeGlyphX.Rendering.Png.QrPngGradientOptions
public QrBuilder WithForegroundPalette(QrPngPaletteOptions palette) #Returns:
QrBuilderSets the foreground palette.
Parameters
- palette CodeGlyphX.Rendering.Png.QrPngPaletteOptions
public QrBuilder WithForegroundPaletteZones(QrPngPaletteZoneOptions zones) #Returns:
QrBuilderSets palette overrides for specific zones.
Parameters
- zones CodeGlyphX.Rendering.Png.QrPngPaletteZoneOptions
public QrBuilder WithIcoPreserveAspectRatio(Boolean enabled = true) #Returns:
QrBuilderSets ICO aspect ratio preservation behavior.
Parameters
- enabled System.Boolean = true
public QrBuilder WithIcoSizes(params Int32[] sizes) #Returns:
QrBuilderSets ICO output sizes (in pixels).
Parameters
- sizes System.Int32[]
public QrBuilder WithLogoBackground(Boolean enabled = true) #Returns:
QrBuilderSets whether to draw a background plate behind the logo.
Parameters
- enabled System.Boolean = true
public QrBuilder WithLogoBackgroundAutoBump(Boolean enabled = true) #Returns:
QrBuilderEnables/disables auto-bumping the minimum version for logo background plates.
Parameters
- enabled System.Boolean = true
public QrBuilder WithLogoBackgroundColor(Nullable<Rgba32> color) #Returns:
QrBuilderSets the logo background color.
Parameters
- color System.Nullable{CodeGlyphX.Rendering.Png.Rgba32}
public QrBuilder WithLogoBackgroundMinVersion(Int32 minVersion) #Returns:
QrBuilderSets the minimum version used when a logo background plate is enabled.
Parameters
- minVersion System.Int32
public QrBuilder WithLogoCornerRadiusPx(Int32 radiusPx) #Returns:
QrBuilderSets the logo background corner radius in pixels.
Parameters
- radiusPx System.Int32
public QrBuilder WithLogoFile(String path) #Returns:
QrBuilderSets an embedded logo from a PNG file.
Parameters
- path System.String
public QrBuilder WithLogoPaddingPx(Int32 paddingPx) #Returns:
QrBuilderSets the logo padding in pixels.
Parameters
- paddingPx System.Int32
public QrBuilder WithLogoPng(Byte[] png) #Returns:
QrBuilderSets an embedded logo from PNG bytes.
Parameters
- png System.Byte[]
public QrBuilder WithLogoScale(Double scale) #Returns:
QrBuilderSets the logo scale relative to the QR area (excluding quiet zone).
Parameters
- scale System.Double
public QrBuilder WithModuleCornerRadiusPx(Int32 radiusPx) #Returns:
QrBuilderSets module corner radius in pixels.
Parameters
- radiusPx System.Int32
public QrBuilder WithModuleJitter(QrPngModuleJitterOptions jitter) #Returns:
QrBuilderSets per-module jitter options.
Parameters
- jitter CodeGlyphX.Rendering.Png.QrPngModuleJitterOptions
public QrBuilder WithModuleScale(Double scale) #Returns:
QrBuilderSets module scale override (0.1..1.0).
Parameters
- scale System.Double
public QrBuilder WithModuleScaleMap(QrPngModuleScaleMapOptions map) #Returns:
QrBuilderSets module scale map.
Parameters
- map CodeGlyphX.Rendering.Png.QrPngModuleScaleMapOptions
public QrBuilder WithModuleShape(QrPngModuleShape shape) #Returns:
QrBuilderSets module shape override.
Parameters
- shape CodeGlyphX.Rendering.Png.QrPngModuleShape
public QrBuilder WithModuleShapeMap(QrPngModuleShapeMapOptions map) #Returns:
QrBuilderSets module shape map.
Parameters
- map CodeGlyphX.Rendering.Png.QrPngModuleShapeMapOptions
public QrBuilder WithModuleSize(Int32 moduleSize) #Returns:
QrBuilderSets the module size in pixels.
Parameters
- moduleSize System.Int32
public QrBuilder WithOptions(Action<QrEasyOptions> configure) #Returns:
QrBuilderUpdates rendering options.
Parameters
- configure System.Action{CodeGlyphX.QrEasyOptions}
public QrBuilder WithQuietZone(Int32 quietZone) #Returns:
QrBuilderSets the quiet zone size in modules.
Parameters
- quietZone System.Int32
public QrBuilder WithStyle(QrRenderStyle style) #Returns:
QrBuilderSets the render style preset.
Parameters
- style CodeGlyphX.QrRenderStyle
public QrBuilder WithTargetSize(Int32 sizePx, Boolean includeQuietZone = true) #Returns:
QrBuilderSets a fixed target size (in pixels). Module size is adjusted to fit.
Parameters
- sizePx System.Int32
- includeQuietZone System.Boolean = true
public QrBuilder WithTransparentBackground() #Returns:
QrBuilderUses a transparent background (alpha = 0).
Inherited Methods
Properties
public QrEasyOptions Options { get; } #Rendering options used by this builder.