CodeGlyphX logo
CodeGlyphX

API Reference

Class

Pdf417Builder

Edit on GitHub
Namespace CodeGlyphX
Assembly CodeGlyphX
Source ../../../../_/CodeGlyphX/Pdf417Code.Builder.cs:52
Modifiers sealed

Fluent PDF417 builder returned by MatrixOptions).

Inheritance

  • Object
  • Pdf417Builder

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

Methods

public BitMatrix Encode() #
../../../../_/CodeGlyphX/Pdf417Code.Builder.cs:193
Returns: BitMatrix

Encodes the PDF417 as a module matrix.

public RenderedOutput Render(OutputFormat format, RenderExtras extras = null) #
../../../../_/CodeGlyphX/Pdf417Code.Builder.cs:200
Returns: RenderedOutput

Renders the configured PDF417 code to the requested output format.

Parameters

format CodeGlyphX.Rendering.OutputFormat requiredposition: 0
extras CodeGlyphX.Rendering.RenderExtras = null optionalposition: 1
Save 2 overloads
public String Save(String path, RenderExtras extras = null) #
../../../../_/CodeGlyphX/Pdf417Code.Builder.cs:209
Returns: String

Saves the configured PDF417 code, selecting the output format from the file extension.

Parameters

path System.String requiredposition: 0
extras CodeGlyphX.Rendering.RenderExtras = null optionalposition: 1
public Void Save(Stream stream, OutputFormat format, RenderExtras extras = null) #
../../../../_/CodeGlyphX/Pdf417Code.Builder.cs:217
Returns: Void

Writes the configured PDF417 code to a stream in the requested output format.

Parameters

stream System.IO.Stream requiredposition: 0
format CodeGlyphX.Rendering.OutputFormat requiredposition: 1
extras CodeGlyphX.Rendering.RenderExtras = null optionalposition: 2
public Pdf417Builder WithAspectRatio(Single ratio) #
../../../../_/CodeGlyphX/Pdf417Code.Builder.cs:159
Returns: Pdf417Builder

Sets target aspect ratio (width/height).

Parameters

ratio System.Single requiredposition: 0
public Pdf417Builder WithColors(Rgba32 foreground, Rgba32 background) #
../../../../_/CodeGlyphX/Pdf417Code.Builder.cs:86
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) #
../../../../_/CodeGlyphX/Pdf417Code.Builder.cs:167
Returns: Pdf417Builder

Sets column constraints.

Parameters

minColumns System.Int32 requiredposition: 0
maxColumns System.Int32 requiredposition: 1
public Pdf417Builder WithCompact(Boolean compact = true) #
../../../../_/CodeGlyphX/Pdf417Code.Builder.cs:185
Returns: Pdf417Builder

Enables compact PDF417.

Parameters

compact System.Boolean = true optionalposition: 0
public Pdf417Builder WithCompaction(Pdf417Compaction compaction) #
../../../../_/CodeGlyphX/Pdf417Code.Builder.cs:135
Returns: Pdf417Builder

Sets compaction mode.

Parameters

compaction CodeGlyphX.Pdf417.Pdf417Compaction requiredposition: 0
public Pdf417Builder WithEncodeOptions(Action<Pdf417EncodeOptions> configure) #
../../../../_/CodeGlyphX/Pdf417Code.Builder.cs:52
Returns: Pdf417Builder

Mutates PDF417 encoding options.

Parameters

configure System.Action{CodeGlyphX.Pdf417.Pdf417EncodeOptions} requiredposition: 0
public Pdf417Builder WithErrorCorrection(Int32 level) #
../../../../_/CodeGlyphX/Pdf417Code.Builder.cs:143
Returns: Pdf417Builder

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

Parameters

level System.Int32 requiredposition: 0
public Pdf417Builder WithHtmlEmailSafeTable(Boolean enabled = true) #
../../../../_/CodeGlyphX/Pdf417Code.Builder.cs:111
Returns: Pdf417Builder

Enables HTML email-safe table rendering.

Parameters

enabled System.Boolean = true optionalposition: 0
public Pdf417Builder WithIcoPreserveAspectRatio(Boolean enabled = true) #
../../../../_/CodeGlyphX/Pdf417Code.Builder.cs:127
Returns: Pdf417Builder

Sets ICO aspect ratio preservation behavior.

Parameters

enabled System.Boolean = true optionalposition: 0
public Pdf417Builder WithIcoSizes(params Int32[] sizes) #
../../../../_/CodeGlyphX/Pdf417Code.Builder.cs:119
Returns: Pdf417Builder

Sets ICO output sizes (in pixels).

Parameters

sizes System.Int32[] requiredposition: 0
public Pdf417Builder WithJpegOptions(JpegEncodeOptions options) #
../../../../_/CodeGlyphX/Pdf417Code.Builder.cs:103
Returns: Pdf417Builder

Sets JPEG encoding options.

Parameters

options CodeGlyphX.Rendering.Jpeg.JpegEncodeOptions requiredposition: 0
public Pdf417Builder WithJpegQuality(Int32 quality) #
../../../../_/CodeGlyphX/Pdf417Code.Builder.cs:95
Returns: Pdf417Builder

Sets JPEG quality (1..100).

Parameters

quality System.Int32 requiredposition: 0
public Pdf417Builder WithModuleSize(Int32 moduleSize) #
../../../../_/CodeGlyphX/Pdf417Code.Builder.cs:70
Returns: Pdf417Builder

Sets module size in pixels.

Parameters

moduleSize System.Int32 requiredposition: 0
public Pdf417Builder WithQuietZone(Int32 quietZone) #
../../../../_/CodeGlyphX/Pdf417Code.Builder.cs:78
Returns: Pdf417Builder

Sets quiet zone size in modules.

Parameters

quietZone System.Int32 requiredposition: 0
public Pdf417Builder WithRenderOptions(Action<MatrixOptions> configure) #
../../../../_/CodeGlyphX/Pdf417Code.Builder.cs:61
Returns: Pdf417Builder

Mutates rendering options.

Parameters

configure System.Action{CodeGlyphX.MatrixOptions} requiredposition: 0
public Pdf417Builder WithRows(Int32 minRows, Int32 maxRows) #
../../../../_/CodeGlyphX/Pdf417Code.Builder.cs:176
Returns: Pdf417Builder

Sets row constraints.

Parameters

minRows System.Int32 requiredposition: 0
maxRows System.Int32 requiredposition: 1
public Pdf417Builder WithTextEncoding(Encoding encoding) #
../../../../_/CodeGlyphX/Pdf417Code.Builder.cs:151
Returns: Pdf417Builder

Sets text encoding for byte compaction.

Parameters

encoding System.Text.Encoding requiredposition: 0