CodeGlyphX logo
CodeGlyphX

API Reference

Class

BarcodeBuilder

Edit on GitHub
Namespace CodeGlyphX
Assembly CodeGlyphX
Source ../../../../_/CodeGlyphX/Barcode.Builder.cs:47
Modifiers sealed

Fluent barcode builder returned by BarcodeOptions).

Inheritance

  • Object
  • BarcodeBuilder

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 Barcode1D Encode() #
../../../../_/CodeGlyphX/Barcode.Builder.cs:184
Returns: Barcode1D

Encodes the barcode.

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

Renders the configured barcode 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/Barcode.Builder.cs:197
Returns: String

Saves the configured barcode, 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/Barcode.Builder.cs:205
Returns: Void

Writes the configured barcode 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 BarcodeBuilder WithBackground(Rgba32 color) #
../../../../_/CodeGlyphX/Barcode.Builder.cs:97
Returns: BarcodeBuilder

Sets background color.

Parameters

color CodeGlyphX.Rendering.Png.Rgba32 requiredposition: 0
public BarcodeBuilder WithColors(Rgba32 foreground, Rgba32 background) #
../../../../_/CodeGlyphX/Barcode.Builder.cs:80
Returns: BarcodeBuilder

Sets foreground and background colors.

Parameters

foreground CodeGlyphX.Rendering.Png.Rgba32 requiredposition: 0
background CodeGlyphX.Rendering.Png.Rgba32 requiredposition: 1
public BarcodeBuilder WithForeground(Rgba32 color) #
../../../../_/CodeGlyphX/Barcode.Builder.cs:89
Returns: BarcodeBuilder

Sets foreground color.

Parameters

color CodeGlyphX.Rendering.Png.Rgba32 requiredposition: 0
public BarcodeBuilder WithHeight(Int32 heightModules) #
../../../../_/CodeGlyphX/Barcode.Builder.cs:72
Returns: BarcodeBuilder

Sets barcode height in modules.

Parameters

heightModules System.Int32 requiredposition: 0
public BarcodeBuilder WithIcoPreserveAspectRatio(Boolean enabled = true) #
../../../../_/CodeGlyphX/Barcode.Builder.cs:177
Returns: BarcodeBuilder

Sets ICO aspect ratio preservation behavior.

Parameters

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

Sets ICO output sizes (in pixels).

Parameters

sizes System.Int32[] requiredposition: 0
public BarcodeBuilder WithJpegOptions(JpegEncodeOptions options) #
../../../../_/CodeGlyphX/Barcode.Builder.cs:121
Returns: BarcodeBuilder

Sets JPEG encoding options.

Parameters

options CodeGlyphX.Rendering.Jpeg.JpegEncodeOptions requiredposition: 0
public BarcodeBuilder WithJpegQuality(Int32 quality) #
../../../../_/CodeGlyphX/Barcode.Builder.cs:113
Returns: BarcodeBuilder

Sets JPEG quality.

Parameters

quality System.Int32 requiredposition: 0
public BarcodeBuilder WithLabel(String text) #
../../../../_/CodeGlyphX/Barcode.Builder.cs:129
Returns: BarcodeBuilder

Sets label text rendered under bars.

Parameters

text System.String requiredposition: 0
public BarcodeBuilder WithLabelColor(Rgba32 color) #
../../../../_/CodeGlyphX/Barcode.Builder.cs:153
Returns: BarcodeBuilder

Sets label color.

Parameters

color CodeGlyphX.Rendering.Png.Rgba32 requiredposition: 0
public BarcodeBuilder WithLabelFontFamily(String fontFamily) #
../../../../_/CodeGlyphX/Barcode.Builder.cs:161
Returns: BarcodeBuilder

Sets label font family (SVG/HTML).

Parameters

fontFamily System.String requiredposition: 0
public BarcodeBuilder WithLabelFontSize(Int32 fontSizePx) #
../../../../_/CodeGlyphX/Barcode.Builder.cs:137
Returns: BarcodeBuilder

Sets label font size in pixels.

Parameters

fontSizePx System.Int32 requiredposition: 0
public BarcodeBuilder WithLabelMargin(Int32 marginPx) #
../../../../_/CodeGlyphX/Barcode.Builder.cs:145
Returns: BarcodeBuilder

Sets label margin in pixels.

Parameters

marginPx System.Int32 requiredposition: 0
public BarcodeBuilder WithModuleSize(Int32 moduleSize) #
../../../../_/CodeGlyphX/Barcode.Builder.cs:56
Returns: BarcodeBuilder

Sets module size.

Parameters

moduleSize System.Int32 requiredposition: 0
public BarcodeBuilder WithOptions(Action<BarcodeOptions> configure) #
../../../../_/CodeGlyphX/Barcode.Builder.cs:47
Returns: BarcodeBuilder

Updates rendering options.

Parameters

configure System.Action{CodeGlyphX.BarcodeOptions} requiredposition: 0
public BarcodeBuilder WithQuietZone(Int32 quietZone) #
../../../../_/CodeGlyphX/Barcode.Builder.cs:64
Returns: BarcodeBuilder

Sets quiet zone size.

Parameters

quietZone System.Int32 requiredposition: 0
public BarcodeBuilder WithTransparentBackground() #
../../../../_/CodeGlyphX/Barcode.Builder.cs:105
Returns: BarcodeBuilder

Uses a transparent background (alpha = 0).

Properties

public BarcodeOptions Options { get; } #
../../../../_/CodeGlyphX/Barcode.Builder.cs:35

Rendering options used by this builder.