API Reference
Class
DataMatrixBuilder
Fluent Data Matrix builder returned by MatrixOptions).
Inheritance
- Object
- DataMatrixBuilder
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 DataMatrixBuilder.WithColors
- Method DataMatrixBuilder.WithHtmlEmailSafeTable
- Method DataMatrixBuilder.WithIcoPreserveAspectRatio
- Method DataMatrixBuilder.WithIcoSizes
- Method DataMatrixBuilder.WithJpegOptions
- Method DataMatrixBuilder.WithJpegQuality
- Method DataMatrixBuilder.WithMode
- Method DataMatrixBuilder.WithModuleSize
- Method DataMatrixBuilder.WithOptions
- Method DataMatrixBuilder.WithQuietZone
- Method DataMatrixCode.Create
Methods
public RenderedOutput Render(OutputFormat format, RenderExtras extras = null) #Returns:
RenderedOutputRenders the configured Data Matrix to the requested output format.
Parameters
- format CodeGlyphX.Rendering.OutputFormat
- extras CodeGlyphX.Rendering.RenderExtras = null
Save 2 overloads
public String Save(String path, RenderExtras extras = null) #Returns:
StringSaves the configured Data Matrix, selecting the output format from the file extension.
Parameters
- path System.String
- extras CodeGlyphX.Rendering.RenderExtras = null
public Void Save(Stream stream, OutputFormat format, RenderExtras extras = null) #Returns:
VoidWrites the configured Data Matrix to a stream in the requested output format.
Parameters
- stream System.IO.Stream
- format CodeGlyphX.Rendering.OutputFormat
- extras CodeGlyphX.Rendering.RenderExtras = null
public DataMatrixBuilder WithColors(Rgba32 foreground, Rgba32 background) #Returns:
DataMatrixBuilderSets foreground/background colors.
Parameters
- foreground CodeGlyphX.Rendering.Png.Rgba32
- background CodeGlyphX.Rendering.Png.Rgba32
public DataMatrixBuilder WithHtmlEmailSafeTable(Boolean enabled = true) #Returns:
DataMatrixBuilderEnables HTML email-safe table rendering.
Parameters
- enabled System.Boolean = true
public DataMatrixBuilder WithIcoPreserveAspectRatio(Boolean enabled = true) #Returns:
DataMatrixBuilderSets ICO aspect ratio preservation behavior.
Parameters
- enabled System.Boolean = true
public DataMatrixBuilder WithIcoSizes(params Int32[] sizes) #Returns:
DataMatrixBuilderSets ICO output sizes (in pixels).
Parameters
- sizes System.Int32[]
public DataMatrixBuilder WithJpegOptions(JpegEncodeOptions options) #Returns:
DataMatrixBuilderSets JPEG encoding options.
Parameters
- options CodeGlyphX.Rendering.Jpeg.JpegEncodeOptions
public DataMatrixBuilder WithJpegQuality(Int32 quality) #Returns:
DataMatrixBuilderSets JPEG quality (1..100).
Parameters
- quality System.Int32
public DataMatrixBuilder WithMode(DataMatrixEncodingMode mode) #Returns:
DataMatrixBuilderSets the encoding mode.
Parameters
- mode CodeGlyphX.DataMatrix.DataMatrixEncodingMode
public DataMatrixBuilder WithModuleSize(Int32 moduleSize) #Returns:
DataMatrixBuilderSets module size in pixels.
Parameters
- moduleSize System.Int32
public DataMatrixBuilder WithOptions(Action<MatrixOptions> configure) #Returns:
DataMatrixBuilderMutates rendering options.
Parameters
- configure System.Action{CodeGlyphX.MatrixOptions}
public DataMatrixBuilder WithQuietZone(Int32 quietZone) #Returns:
DataMatrixBuilderSets quiet zone size in modules.
Parameters
- quietZone System.Int32
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object