Click or drag to resize

GeneratedBarcode Class

A barcode generated by IronBarCode.

In addition to exporting the barcode as a graphic, we may also resize it, recolor it and annotate it with this class using fluent notation.

GeneratedBarcodes may be exported as Images, Objects or PDF files. They may also be exported as HTML for use on the web.

Inheritance Hierarchy
SystemObject
  IronBarCodeGeneratedBarcode

Namespace:  IronBarCode
Assembly:  IronBarCode (in IronBarCode.dll) Version: 4.0.1.22591 (4.0.1.0)
Syntax
public class GeneratedBarcode

The GeneratedBarcode type exposes the following members.

Properties
  NameDescription
Public propertyBarcodeType
Gets the BarcodeEncoding type of this barcode.
Public propertyBinaryStream
Returns a System.IO.Stream of the barcode rendered as a Bitmap image.
Public propertyBinaryValue
Gets the value of the barcode as binary data
Public propertyHeight
Gets the final height of the generated barcode image in pixels.

Includes the height of margins and annotations

Public propertyImage
Returns the barcode as a Image
Public propertyValue
Gets the text value if the barcode
Public propertyWidth
Gets the final width of the generated barcode image in pixels.

Includes the width of margins and annotations

Top
Methods
  NameDescription
Public methodAddAnnotationTextAboveBarcode(String)
Annotates the barcode with any string of text.

the text is rendered above the barcode. Overloads of this method allow for the typeface and font size to be specific in detail.

Public methodAddAnnotationTextAboveBarcode(String, Font, Color)
Annotates the barcode with any string of text.

the text is rendered above the barcode.

Public methodAddAnnotationTextBelowBarcode(String)
Annotates the barcode with any string of text.

the text is rendered below the barcode. Overloads of this method allow for the typeface and font size to be specific in detail.

Public methodAddAnnotationTextBelowBarcode(String, Font, Color)
Annotates the barcode with any string of text.

the text is rendered below the barcode.

Public methodAddBarcodeValueTextAboveBarcode
Annotates the barcode with text showing it's value.

the barcode value is rendered above the barcode. Overloads of this method allow for the typeface and font size to be specific in detail.

Public methodAddBarcodeValueTextAboveBarcode(Font, Color)
Annotates the barcode with text showing it's value.

the barcode value is rendered above the barcode.

Public methodAddBarcodeValueTextBelowBarcode
Annotates the barcode with text showing it's value.

the barcode value is rendered below the barcode. Overloads of this method allow for the typeface and font size to be specific in detail.

Public methodAddBarcodeValueTextBelowBarcode(Font, Color)
Annotates the barcode with text showing it's value.

the barcode value is rendered below the barcode.

Public methodChangeBackgroundColor
Sets the background color behind the barcode.
Public methodChangeBarCodeColor
Sets the barcode color.
Public methodRender
Renders this barcode to a System.Drawing.Bitmap
Public methodResizeTo
Resizes the Barcode (excluding annotations and margins). This process causes a re-render and is lossless.
Public methodSaveAsGif
Saves the barcode as a GIF image file.
Public methodSaveAsHtmlFile
Saves the Barcode as fully functional and self-contained HTML file.

The image encoding will automatically match the file extension specified in your ImagePath. Defaults to Bitmap image encoding if ambiguous.

Public methodSaveAsImage
Saves the Barcode as an image file.

The image encoding will automatically match the file extension specified in your ImagePath. Defaults to Bitmap image encoding if ambiguous.

Public methodSaveAsJpeg
Saves the barcode as a JPEG image file.
Public methodSaveAsPdf
Saves the barcode as a new PDF document.
Public methodSaveAsPng
Saves the barcode as a PNG image file.
Public methodSaveAsTiff
Saves the barcode as a TIFF image file.
Public methodSaveAsWindowsBitmap
Saves the barcode as a BMP image file.
Public methodSetMargins(Int32)
Sets whitespace margins around the barcode.
Public methodSetMargins(Int32, Int32, Int32, Int32)
Sets whitespace margins around the barcode.
Public methodStampToExistingPdfPage
Stamps (draws) the Barcode onto an existing page of an existing PDF document.
Public methodStampToExistingPdfPages
Stamps (draws) the Barcode onto multiple existing pages of an existing PDF document.
Public methodToBitmap
Renders the barcode as a Bitmap
Public methodToDataUrl
Converts the barcode to a base64 data url.

The data URI scheme is a uniform resource identifier (URI) scheme that provides a way to include data in-line in web pages as if they were external resources. https://en.wikipedia.org/wiki/Data_URI_scheme

Public methodToGifBinaryData
Returns the barcode as the binary data for a GIF image.
Public methodToGifStream
Returns the barcode as a MemoryStream of the binary data for a GIF image.
Public methodToHtmlTag
Renders the barcode as a HTML image Tag. The tag is fully formed (using a data-url> and can be injected into HTML with no JS, CSS or image dependencies.
Public methodToImage
Renders the barcode as a Image
Public methodToJpegBinaryData
Returns the barcode as the binary data for a JPEG/JPG image.
Public methodToJpegStream
Returns the barcode as a MemoryStream of the binary data for a JPEG/JPG image.
Public methodToPdfBinaryData
Returns a 1 page PDF document containing the barcode, as binary data.
Public methodToPdfStream
Returns a binary MemoryStream containing a 1 page PDF document containing the barcode, as binary data.
Public methodToPngBinaryData
Returns the barcode as the binary data for a PNG image.
Public methodToPngStream
Returns the barcode as a MemoryStream of the binary data for a PNG image.
Public methodToStream
Renders the barcode as an image Stream
Public methodToStream(ImageFormat)
Renders the barcode as an image Stream
Public methodToString
Returns a String that represents this GeneratedBarcodes value.
(Overrides ObjectToString.)
Public methodToTiffBinaryData
Returns the barcode as the binary data for a TIFF image.
Public methodToTiffStream
Returns the barcode as a MemoryStream of the binary data as the binary data for a TIFF image.
Public methodToWindowsBitmapBinaryData
Returns the barcode as the binary data for a Bitmap BMP image.
Public methodToWindowsBitmapStream
Returns the barcode as a MemoryStream of the binary data for a Bitmap BMP image.
Public methodVerify
Verifies this barcode is still readable by IronBarCode.

resizing a barcode to a very small size us using unconventional colors may make it unreadable to a machine. This method verifies that a barcode is still fully readable.

Top
Fields
  NameDescription
Public fieldTextEncoding
The text encoding for converting between String barcode values and Binary barcode values
Top
See Also