CodeGlyphX logo
CodeGlyphX

API Reference

Class

Pdf417Builder

Namespace CodeGlyphX.Pdf417Code
Assembly CodeGlyphX
Modifiers sealed

Fluent PDF417 builder.

Inheritance

  • Object
  • Pdf417Builder

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 PDF417 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 Pdf417Builder WithAspectRatio(Single ratio) #
Returns: Pdf417Builder

Sets target aspect ratio (width/height).

Parameters

ratio System.Single requiredposition: 0
public Pdf417Builder WithColors(Rgba32 foreground, Rgba32 background) #
Returns: Pdf417Builder

Sets foreground/background colors.

Parameters

foreground CodeGlyphX.Rendering.Png.Rgba32 requiredposition: 0
background CodeGlyphX.Rendering.Png.Rgba32 requiredposition: 1
public Pdf417Builder WithColumns(Int32 minColumns, Int32 maxColumns) #
Returns: Pdf417Builder

Sets column constraints.

Parameters

minColumns System.Int32 requiredposition: 0
maxColumns System.Int32 requiredposition: 1
public Pdf417Builder WithCompact(Boolean compact = true) #
Returns: Pdf417Builder

Enables compact PDF417.

Parameters

compact System.Boolean = true optionalposition: 0
public Pdf417Builder WithCompaction(Pdf417Compaction compaction) #
Returns: Pdf417Builder

Sets compaction mode.

Parameters

compaction CodeGlyphX.Pdf417.Pdf417Compaction requiredposition: 0
public Pdf417Builder WithEncodeOptions(Action<Pdf417EncodeOptions> configure) #
Returns: Pdf417Builder

Mutates PDF417 encoding options.

Parameters

configure System.Action{CodeGlyphX.Pdf417.Pdf417EncodeOptions} requiredposition: 0
public Pdf417Builder WithErrorCorrection(Int32 level) #
Returns: Pdf417Builder

Sets error correction level (0..8 or -1 for auto).

Parameters

level System.Int32 requiredposition: 0
public Pdf417Builder WithHtmlEmailSafeTable(Boolean enabled = true) #
Returns: Pdf417Builder

Enables HTML email-safe table rendering.

Parameters

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

Sets ICO aspect ratio preservation behavior.

Parameters

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

Sets ICO output sizes (in pixels).

Parameters

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

Sets JPEG encoding options.

Parameters

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

Sets JPEG quality (1..100).

Parameters

quality System.Int32 requiredposition: 0
public Pdf417Builder WithModuleSize(Int32 moduleSize) #
Returns: Pdf417Builder

Sets module size in pixels.

Parameters

moduleSize System.Int32 requiredposition: 0
public Pdf417Builder WithQuietZone(Int32 quietZone) #
Returns: Pdf417Builder

Sets quiet zone size in modules.

Parameters

quietZone System.Int32 requiredposition: 0
public Pdf417Builder WithRenderOptions(Action<MatrixOptions> configure) #
Returns: Pdf417Builder

Mutates rendering options.

Parameters

configure System.Action{CodeGlyphX.MatrixOptions} requiredposition: 0
public Pdf417Builder WithRows(Int32 minRows, Int32 maxRows) #
Returns: Pdf417Builder

Sets row constraints.

Parameters

minRows System.Int32 requiredposition: 0
maxRows System.Int32 requiredposition: 1
public Pdf417Builder WithTextEncoding(Encoding encoding) #
Returns: Pdf417Builder

Sets text encoding for byte compaction.

Parameters

encoding System.Text.Encoding requiredposition: 0