CodeGlyphX logo
CodeGlyphX

API Reference

Class

DataMatrixBuilder

Namespace CodeGlyphX.DataMatrixCode
Assembly CodeGlyphX
Modifiers sealed

Fluent Data Matrix builder.

Inheritance

  • Object
  • DataMatrixBuilder

Usage

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

Methods

public String Ascii(MatrixAsciiRenderOptions options = null) #
Returns: String

Renders ASCII text.

Parameters

options CodeGlyphX.Rendering.Ascii.MatrixAsciiRenderOptions = null optionalposition: 0
public Byte[] Bmp() #
Returns: Byte[]

Renders BMP bytes.

public BitMatrix Encode() #
Returns: BitMatrix

Encodes the Data Matrix as a module matrix.

public String Eps(RenderMode renderMode = Vector) #
Returns: String

Renders EPS text.

Parameters

renderMode CodeGlyphX.Rendering.RenderMode = Vector optionalposition: 0
Vector or raster output.
public String Html() #
Returns: String

Renders HTML markup.

public Byte[] Jpeg() #
Returns: Byte[]

Renders JPEG bytes.

public Byte[] Pdf(RenderMode renderMode = Vector) #
Returns: Byte[]

Renders PDF bytes.

Parameters

renderMode CodeGlyphX.Rendering.RenderMode = Vector optionalposition: 0
Vector or raster output.
public Byte[] Png() #
Returns: Byte[]

Renders PNG bytes.

public String Save(String path, String title = null) #
Returns: String

Saves output based on file extension.

Parameters

path System.String requiredposition: 0
title System.String = null optionalposition: 1
public String SaveBmp(String path) #
Returns: String

Saves BMP to a file.

Parameters

path System.String requiredposition: 0
public String SaveEps(String path, RenderMode renderMode = Vector) #
Returns: String

Saves EPS to a file.

Parameters

path System.String requiredposition: 0
Output file path.
renderMode CodeGlyphX.Rendering.RenderMode = Vector optionalposition: 1
Vector or raster output.
public String SaveHtml(String path, String title = null) #
Returns: String

Saves HTML to a file.

Parameters

path System.String requiredposition: 0
title System.String = null optionalposition: 1
public String SaveJpeg(String path) #
Returns: String

Saves JPEG to a file.

Parameters

path System.String requiredposition: 0
public String SavePdf(String path, RenderMode renderMode = Vector) #
Returns: String

Saves PDF to a file.

Parameters

path System.String requiredposition: 0
Output file path.
renderMode CodeGlyphX.Rendering.RenderMode = Vector optionalposition: 1
Vector or raster output.
public String SavePng(String path) #
Returns: String

Saves PNG to a file.

Parameters

path System.String requiredposition: 0
public String SaveSvg(String path) #
Returns: String

Saves SVG to a file.

Parameters

path System.String requiredposition: 0
public String SaveWebp(String path) #
Returns: String

Saves WebP to a file.

Parameters

path System.String requiredposition: 0
public String Svg() #
Returns: String

Renders SVG markup.

public DataMatrixBuilder WithColors(Rgba32 foreground, Rgba32 background) #
Returns: DataMatrixBuilder

Sets foreground/background colors.

Parameters

foreground CodeGlyphX.Rendering.Png.Rgba32 requiredposition: 0
background CodeGlyphX.Rendering.Png.Rgba32 requiredposition: 1
public DataMatrixBuilder WithHtmlEmailSafeTable(Boolean enabled = true) #
Returns: DataMatrixBuilder

Enables HTML email-safe table rendering.

Parameters

enabled System.Boolean = true optionalposition: 0
public DataMatrixBuilder WithIcoPreserveAspectRatio(Boolean enabled = true) #
Returns: DataMatrixBuilder

Sets ICO aspect ratio preservation behavior.

Parameters

enabled System.Boolean = true optionalposition: 0
public DataMatrixBuilder WithIcoSizes(params Int32[] sizes) #
Returns: DataMatrixBuilder

Sets ICO output sizes (in pixels).

Parameters

sizes System.Int32[] requiredposition: 0
public DataMatrixBuilder WithJpegOptions(JpegEncodeOptions options) #
Returns: DataMatrixBuilder

Sets JPEG encoding options.

Parameters

options CodeGlyphX.Rendering.Jpeg.JpegEncodeOptions requiredposition: 0
public DataMatrixBuilder WithJpegQuality(Int32 quality) #
Returns: DataMatrixBuilder

Sets JPEG quality (1..100).

Parameters

quality System.Int32 requiredposition: 0
public DataMatrixBuilder WithMode(DataMatrixEncodingMode mode) #
Returns: DataMatrixBuilder

Sets the encoding mode.

Parameters

mode CodeGlyphX.DataMatrix.DataMatrixEncodingMode requiredposition: 0
public DataMatrixBuilder WithModuleSize(Int32 moduleSize) #
Returns: DataMatrixBuilder

Sets module size in pixels.

Parameters

moduleSize System.Int32 requiredposition: 0
public DataMatrixBuilder WithOptions(Action<MatrixOptions> configure) #
Returns: DataMatrixBuilder

Mutates rendering options.

Parameters

configure System.Action{CodeGlyphX.MatrixOptions} requiredposition: 0
public DataMatrixBuilder WithQuietZone(Int32 quietZone) #
Returns: DataMatrixBuilder

Sets quiet zone size in modules.

Parameters

quietZone System.Int32 requiredposition: 0