API Reference
Class
BarcodeBuilder
Fluent barcode builder.
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
- Method Barcode.Create
- Method BarcodeBuilder.WithBackground
- Method BarcodeBuilder.WithColors
- Method BarcodeBuilder.WithForeground
- Method BarcodeBuilder.WithHeight
- Method BarcodeBuilder.WithIcoPreserveAspectRatio
- Method BarcodeBuilder.WithIcoSizes
- Method BarcodeBuilder.WithJpegOptions
- Method BarcodeBuilder.WithJpegQuality
- Method BarcodeBuilder.WithLabel
- Method BarcodeBuilder.WithLabelColor
- Method BarcodeBuilder.WithLabelFontFamily
- Method BarcodeBuilder.WithLabelFontSize
- Method BarcodeBuilder.WithLabelMargin
- Method BarcodeBuilder.WithModuleSize
- Method BarcodeBuilder.WithOptions
- Method BarcodeBuilder.WithQuietZone
- Method BarcodeBuilder.WithTransparentBackground
Methods
public String Ascii(BarcodeAsciiRenderOptions options = null) #Returns:
StringRenders ASCII text.
Parameters
- options CodeGlyphX.Rendering.Ascii.BarcodeAsciiRenderOptions = null
public String Eps(RenderMode mode = Vector) #Returns:
StringRenders EPS text.
Parameters
- mode CodeGlyphX.Rendering.RenderMode = Vector
- Vector or raster output.
public Byte[] Pdf(RenderMode mode = Vector) #Returns:
Byte[]Renders PDF bytes.
Parameters
- mode CodeGlyphX.Rendering.RenderMode = Vector
- Vector or raster output.
public String Save(String path, String title = null) #Returns:
StringSaves based on file extension (.png/.svg/.html/.jpg/.bmp/.ppm/.pbm/.tga/.ico/.pdf/.eps). Defaults to PNG when no extension is provided.
Parameters
- path System.String
- title System.String = null
public String SaveAscii(String path, BarcodeAsciiRenderOptions options = null) #Returns:
StringSaves ASCII to a file.
Parameters
- path System.String
- options CodeGlyphX.Rendering.Ascii.BarcodeAsciiRenderOptions = null
SaveBmp 2 overloads
SaveEps 2 overloads
public Void SaveEps(Stream stream, RenderMode mode = Vector) #Returns:
VoidSaves EPS to a file.
Parameters
- path System.String
- Output file path.
- mode CodeGlyphX.Rendering.RenderMode = Vector
- Vector or raster output.
SaveEps(System.IO.Stream stream, CodeGlyphX.Rendering.RenderMode mode) #Saves EPS to a stream.
Parameters
- stream System.IO.Stream
- Destination stream.
- mode CodeGlyphX.Rendering.RenderMode
- Vector or raster output.
SaveHtml 2 overloads
SaveIco 2 overloads
SaveJpeg 2 overloads
SavePam 2 overloads
SavePbm 2 overloads
SavePdf 2 overloads
public Void SavePdf(Stream stream, RenderMode mode = Vector) #Returns:
VoidSaves PDF to a file.
Parameters
- path System.String
- Output file path.
- mode CodeGlyphX.Rendering.RenderMode = Vector
- Vector or raster output.
SavePdf(System.IO.Stream stream, CodeGlyphX.Rendering.RenderMode mode) #Saves PDF to a stream.
Parameters
- stream System.IO.Stream
- Destination stream.
- mode CodeGlyphX.Rendering.RenderMode
- Vector or raster output.
SavePgm 2 overloads
SavePng 2 overloads
SavePpm 2 overloads
SaveSvg 2 overloads
SaveSvgz 2 overloads
SaveTga 2 overloads
SaveWebp 2 overloads
SaveXbm 2 overloads
SaveXpm 2 overloads
public BarcodeBuilder WithBackground(Rgba32 color) #Returns:
BarcodeBuilderSets background color.
Parameters
- color CodeGlyphX.Rendering.Png.Rgba32
public BarcodeBuilder WithColors(Rgba32 foreground, Rgba32 background) #Returns:
BarcodeBuilderSets foreground and background colors.
Parameters
- foreground CodeGlyphX.Rendering.Png.Rgba32
- background CodeGlyphX.Rendering.Png.Rgba32
public BarcodeBuilder WithForeground(Rgba32 color) #Returns:
BarcodeBuilderSets foreground color.
Parameters
- color CodeGlyphX.Rendering.Png.Rgba32
public BarcodeBuilder WithHeight(Int32 heightModules) #Returns:
BarcodeBuilderSets barcode height in modules.
Parameters
- heightModules System.Int32
public BarcodeBuilder WithIcoPreserveAspectRatio(Boolean enabled = true) #Returns:
BarcodeBuilderSets ICO aspect ratio preservation behavior.
Parameters
- enabled System.Boolean = true
public BarcodeBuilder WithIcoSizes(params Int32[] sizes) #Returns:
BarcodeBuilderSets ICO output sizes (in pixels).
Parameters
- sizes System.Int32[]
public BarcodeBuilder WithJpegOptions(JpegEncodeOptions options) #Returns:
BarcodeBuilderSets JPEG encoding options.
Parameters
- options CodeGlyphX.Rendering.Jpeg.JpegEncodeOptions
public BarcodeBuilder WithJpegQuality(Int32 quality) #Returns:
BarcodeBuilderSets JPEG quality.
Parameters
- quality System.Int32
public BarcodeBuilder WithLabel(String text) #Returns:
BarcodeBuilderSets label text rendered under bars.
Parameters
- text System.String
public BarcodeBuilder WithLabelColor(Rgba32 color) #Returns:
BarcodeBuilderSets label color.
Parameters
- color CodeGlyphX.Rendering.Png.Rgba32
public BarcodeBuilder WithLabelFontFamily(String fontFamily) #Returns:
BarcodeBuilderSets label font family (SVG/HTML).
Parameters
- fontFamily System.String
public BarcodeBuilder WithLabelFontSize(Int32 fontSizePx) #Returns:
BarcodeBuilderSets label font size in pixels.
Parameters
- fontSizePx System.Int32
public BarcodeBuilder WithLabelMargin(Int32 marginPx) #Returns:
BarcodeBuilderSets label margin in pixels.
Parameters
- marginPx System.Int32
public BarcodeBuilder WithModuleSize(Int32 moduleSize) #Returns:
BarcodeBuilderSets module size.
Parameters
- moduleSize System.Int32
public BarcodeBuilder WithOptions(Action<BarcodeOptions> configure) #Returns:
BarcodeBuilderUpdates rendering options.
Parameters
- configure System.Action{CodeGlyphX.BarcodeOptions}
public BarcodeBuilder WithQuietZone(Int32 quietZone) #Returns:
BarcodeBuilderSets quiet zone size.
Parameters
- quietZone System.Int32
public BarcodeBuilder WithTransparentBackground() #Returns:
BarcodeBuilderUses a transparent background (alpha = 0).
Inherited Methods
Properties
public BarcodeOptions Options { get; } #Rendering options used by this builder.