Class Barcode

Neodynamic's Barcode .NET component for Microsoft SQL Server Reporting Services allows you to quickly and easily add barcodes to your reports.

Inheritance

System.Object

Barcode

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Neodynamic.ReportingServices

Assembly: Neodynamic.ReportingServices.Barcode.dll

Syntax

public class Barcode : IDisposable

Constructors

Barcode()

Initializes a new instance of the Barcode class for use it into Reporting Services reports.

Declaration

public Barcode()

Properties

AddChecksum

Gets or sets whether checksum must be generated and attached to the value to encode.

Declaration

public bool AddChecksum { get; set; }

Property Value

Type	Description
System.Boolean

AntiAlias

It indicates if AntiAlias effect must be applied to all the texts in the barcode image.

Declaration

public bool AntiAlias { get; set; }

Property Value

Type	Description
System.Boolean

ArtBarImagePattern

Gets or sets the image file (path or Base64 string) that will be used as a pattern to fill all the bars that compose the barcode symbol.

Declaration

public string ArtBarImagePattern { get; set; }

Property Value

Type	Description
System.String

ArtFinderShape

Gets or sets the barcode symbol finders artistic shape. Default is Rect.

Declaration

public ArtFinderShape ArtFinderShape { get; set; }

Property Value

Type	Description
ArtFinderShape

ArtLogoImage

Gets or sets the logo image file (path or Base64 string) that will be used to stamp it on top or bottom of the barcode symbol.

Declaration

public string ArtLogoImage { get; set; }

Property Value

Type	Description
System.String

ArtLogoImageOpacity

Gets or sets the opacity [from 1 to 100 (fully opaque)] of the image logo file. Default is 100.

Declaration

public int ArtLogoImageOpacity { get; set; }

Property Value

Type	Description
System.Int32

ArtLogoImagePercentage

Gets or sets the percentage used to resize the logo image based on the barcode symbol size. Default is 20.

Declaration

public int ArtLogoImagePercentage { get; set; }

Property Value

Type	Description
System.Int32

ArtLogoImagePosition

Gets or sets the position of the logo image file on the barcode symbol. Default is Top.

Declaration

public LogoPosition ArtLogoImagePosition { get; set; }

Property Value

Type	Description
LogoPosition

ArtModuleShape

Gets or sets the barcode symbol modules/bars artistic shape. Default is Rect.

Declaration

public ArtModuleShape ArtModuleShape { get; set; }

Property Value

Type	Description
ArtModuleShape

AutoSize

Gets or sets a value indicating whether the barcode image is automatically resized to display its entire contents.

Declaration

public bool AutoSize { get; set; }

Property Value

Type	Description
System.Boolean

AztecCodeByteEncodingName

Gets or sets the Encoding Name (Code Page) to be used for Aztec Code in Byte Compaction mode. Default it ISO-8859-1.

Declaration

public string AztecCodeByteEncodingName { get; set; }

Property Value

Type	Description
System.String

AztecCodeErrorCorrection

Gets or sets the Error Correction Percentage to apply for Aztec Code symbology. Default is 23.

Declaration

public int AztecCodeErrorCorrection { get; set; }

Property Value

Type	Description
System.Int32

AztecCodeFormat

Gets or sets the Aztec Code Format to use on that symbology.

Declaration

public AztecCodeFormat AztecCodeFormat { get; set; }

Property Value

Type	Description
AztecCodeFormat

AztecCodeModuleSize

Gets or sets the module size. The unit of measure must be specified to BarcodeUnit property.

Declaration

public double AztecCodeModuleSize { get; set; }

Property Value

Type	Description
System.Double

AztecCodeProcessTilde

Gets or sets whether tilde character should be processed when Aztec Code is being generated.

Declaration

public bool AztecCodeProcessTilde { get; set; }

Property Value

Type	Description
System.Boolean

AztecCodeRune

Gets or sets the Aztec Code Rune value. It must be a value from 0 to 255 and is available for Aztec Code Compact Format only.

Declaration

public int AztecCodeRune { get; set; }

Property Value

Type	Description
System.Int32

BackColor

Gets or sets the background color for the barcode image.

Declaration

public Color BackColor { get; set; }

Property Value

Type	Description
System.Drawing.Color

BarcodeAlignment

Gets or sets the alignment of the whole barcode on the drawing surface.

Declaration

public BarcodeAlignment BarcodeAlignment { get; set; }

Property Value

Type	Description
BarcodeAlignment

BarcodePaddingBottom

Gets or sets the extra space between the barcode content and the bottom border. The unit of measure must be specified to BarcodeUnit property.

Declaration

public double BarcodePaddingBottom { get; set; }

Property Value

Type	Description
System.Double

BarcodePaddingLeft

Gets or sets the extra space between the barcode content and the left border. The unit of measure must be specified to BarcodeUnit property.

Declaration

public double BarcodePaddingLeft { get; set; }

Property Value

Type	Description
System.Double

BarcodePaddingRight

Gets or sets the extra space between the barcode content and the right border. The unit of measure must be specified to BarcodeUnit property.

Declaration

public double BarcodePaddingRight { get; set; }

Property Value

Type	Description
System.Double

BarcodePaddingTop

Gets or sets the extra space between the barcode content and the top border. The unit of measure must be specified to BarcodeUnit property.

Declaration

public double BarcodePaddingTop { get; set; }

Property Value

Type	Description
System.Double

BarcodeUnit

Gets or sets the unit of measure for the barcode dimensions. Defauls is Inch. It must precede any barcode dimension properties settings.

Declaration

public BarcodeUnit BarcodeUnit { get; set; }

Property Value

Type	Description
BarcodeUnit

BarColor

Gets or sets the bars' color of the barcode.

Declaration

public Color BarColor { get; set; }

Property Value

Type	Description
System.Drawing.Color

BarHeight

Gets or sets the bars' height of the barcode. The unit of measure must be specified to BarcodeUnit property.

Declaration

public double BarHeight { get; set; }

Property Value

Type	Description
System.Double

BarRatio

Gets or sets the wide bars' width compared to the narrow bars' width. In barcode terminology this is N value.

Declaration

public double BarRatio { get; set; }

Property Value

Type	Description
System.Double

BarWidth

Gets or sets the narrow bars' width of the barcode. In barcode terminology this is X value. The unit of measure must be specified to BarcodeUnit property.

Declaration

public double BarWidth { get; set; }

Property Value

Type	Description
System.Double

BarWidthAdjustment

Gets or sets the Bar Width Adjustment.

Declaration

public double BarWidthAdjustment { get; set; }

Property Value

Type	Description
System.Double

BearerBarStyle

Gets or set the bearer bars' type that must be drawn with the barcode image. Bearer bar is only available for 2 of 5, Code 128 and UCC.EAN 128 barcodes.

Declaration

public BearerBarStyle BearerBarStyle { get; set; }

Property Value

Type	Description
BearerBarStyle

BearerBarWidth

Gets or sets the bearer bars' width. The unit of measure must be specified to BarcodeUnit property.

Declaration

public double BearerBarWidth { get; set; }

Property Value

Type	Description
System.Double

BorderColor

Gets or sets the barcode image border's color.

Declaration

public Color BorderColor { get; set; }

Property Value

Type	Description
System.Drawing.Color

BorderRadius

Gets or sets the barcode border's radius. The unit of measure must be specified to BarcodeUnit property.

Declaration

public double BorderRadius { get; set; }

Property Value

Type	Description
System.Double

BorderWidth

Gets or sets the barcode image border's width to generate.

Declaration

public double BorderWidth { get; set; }

Property Value

Type	Description
System.Double

BottomMargin

Gets or sets the height of the margin below the barcode bars. The unit of measure must be specified to BarcodeUnit property.

Declaration

public double BottomMargin { get; set; }

Property Value

Type	Description
System.Double

ChannelCode

Gets or sets the Channel Code. Its value must be from 3 up to 8. Default is 8.

Declaration

public int ChannelCode { get; set; }

Property Value

Type	Description
System.Int32

Remarks

Each channel code supports its own range of values: Channel 3 [0-26], Channel 4 [0-292], Channel 5 [0-3493], Channel 6 [0-44072], Channel 7 [0-576688], and Channel 8 [0-7742862]

CodabarStartChar

Gets or sets the start character for Codabar symbology. Possible values are: A, B, C or D.

Declaration

public CodabarStartStopChar CodabarStartChar { get; set; }

Property Value

Type	Description
CodabarStartStopChar

CodabarStopChar

Gets or sets the stop character for Codabar symbology. Possible values are: A, B, C or D.

Declaration

public CodabarStartStopChar CodabarStopChar { get; set; }

Property Value

Type	Description
CodabarStartStopChar

Code

Gets or sets the value to encode.

Declaration

public string Code { get; set; }

Property Value

Type	Description
System.String

Code11TwoDigitsChecksum

Gets or sets whether Code 11 two digits checksum must be calculated and encoded. Defauls is false.

Declaration

public bool Code11TwoDigitsChecksum { get; set; }

Property Value

Type	Description
System.Boolean

Code128CharSet

Gets or sets the characters set to use in the Code 128 symbology. Possible values are: Auto, A, B or C.

Declaration

public Code128 Code128CharSet { get; set; }

Property Value

Type	Description
Code128

Code16kMode

Gets or sets the mode to use for Code16k symbology. Modes supported are: Mode 0, 1, and 2.

Declaration

public Code16k Code16kMode { get; set; }

Property Value

Type	Description
Code16k

CodeAlignment

Gets or sets the text alignment for Code property.

Declaration

public Alignment CodeAlignment { get; set; }

Property Value

Type	Description
Alignment

CodeFormatPattern

Gets or sets the string pattern to format the Code property. The result of the format process is the one which will be encoded! Based on String.Format(). Default value is empty (Disabled).

Declaration

public string CodeFormatPattern { get; set; }

Property Value

Type	Description
System.String

DataMatrixByteEncodingName

Gets or sets the Encoding Name (Code Page) to be used for DataMatrix in Byte Compaction mode. Default it ISO-8859-1.

Declaration

public string DataMatrixByteEncodingName { get; set; }

Property Value

Type	Description
System.String

DataMatrixEncoding

Gets or sets the DataMatrix Encoding to use on that symbology.

Declaration

public DataMatrixEncoding DataMatrixEncoding { get; set; }

Property Value

Type	Description
DataMatrixEncoding

DataMatrixFileId

Gets or sets the File ID of the Data Matrix symbol. Its value must be a sequence of codewords (Each codeword value must be a number between 001 and 254) and must be the same for all data segments.

Declaration

public string DataMatrixFileId { get; set; }

Property Value

Type	Description
System.String

DataMatrixFormat

Gets or sets the DataMatrix Format to use on that symbology.

Declaration

public DataMatrixFormat DataMatrixFormat { get; set; }

Property Value

Type	Description
DataMatrixFormat

DataMatrixIncludeRectFormatsInAutoMode

Gets or sets whether to consider Rectangular DataMatrix Formats when DataMatrixFormat is set to Auto. Default is false.

Declaration

public bool DataMatrixIncludeRectFormatsInAutoMode { get; set; }

Property Value

Type	Description
System.Boolean

DataMatrixModuleSize

Gets or sets the module size. The unit of measure must be specified to BarcodeUnit property.

Declaration

public double DataMatrixModuleSize { get; set; }

Property Value

Type	Description
System.Double

DataMatrixProcessTilde

Gets or sets whether tilde character should be processed when DataMatrix code is being generated.

Declaration

public bool DataMatrixProcessTilde { get; set; }

Property Value

Type	Description
System.Boolean

DataMatrixSymbolCount

Gets or sets the number of Data Matrix symbols. Its value must be less than or equal to 16.

Declaration

public int DataMatrixSymbolCount { get; set; }

Property Value

Type	Description
System.Int32

DataMatrixSymbolIndex

Gets or sets the Index for a Data Matrix symbol. Its value must be 1 up to 16 and must be less than or equal to the value in DataMatrixSegmentCount property.

Declaration

public int DataMatrixSymbolIndex { get; set; }

Property Value

Type	Description
System.Int32

DisplayChecksum

Gets or sets whether checksum value must be displayed after the value to encode in the barcode image.

Declaration

public bool DisplayChecksum { get; set; }

Property Value

Type	Description
System.Boolean

DisplayCode

Gets or sets whether the value to encode must be displayed in the barcode image.

Declaration

public bool DisplayCode { get; set; }

Property Value

Type	Description
System.Boolean

DisplayLightMarginIndicator

Gets or sets whether light margin indicators must be displayed in the barcode image. Only available for EAN/UPC Symbologies.

Declaration

public bool DisplayLightMarginIndicator { get; set; }

Property Value

Type	Description
System.Boolean

DisplayStartStopChar

Gets or sets whether start and stop characters must be displayed in the barcode image.

Declaration

public bool DisplayStartStopChar { get; set; }

Property Value

Type	Description
System.Boolean

DotCodeAspectRatio

Gets or sets the Columns (width) to Rows (height) Aspect Ratio for DotCode symbology. Aspect Ratio must be specified as C:R where C and R are integers e.g. 3:2

Declaration

public string DotCodeAspectRatio { get; set; }

Property Value

Type	Description
System.String

DotCodeColumns

Gets or sets the number of columns to use for DotCode symbology. Default is zero i.e. auto.

Declaration

public int DotCodeColumns { get; set; }

Property Value

Type	Description
System.Int32

DotCodeModuleShape

Gets or sets the shape of the modules that make the DotCode barcode symbol. Default is Circle.

Declaration

public DotCodeModuleShape DotCodeModuleShape { get; set; }

Property Value

Type	Description
DotCodeModuleShape

DotCodeModuleSize

Gets or sets the module size. The unit of measure must be specified to BarcodeUnit property.

Declaration

public double DotCodeModuleSize { get; set; }

Property Value

Type	Description
System.Double

DotCodeProcessTilde

Gets or sets whether tilde character should be processed when DotCode is being generated.

Declaration

public bool DotCodeProcessTilde { get; set; }

Property Value

Type	Description
System.Boolean

DotCodeRows

Gets or sets the number of rows to use for DotCode symbology. Default is zero i.e. auto.

Declaration

public int DotCodeRows { get; set; }

Property Value

Type	Description
System.Int32

Dpi

Gets or sets the barcode image resolution in dots per inch.

Declaration

public float Dpi { get; set; }

Property Value

Type	Description
System.Single

EanUpcAutoBWAfor1278DigitsEnabled

Gets or sets whether the recommended Bar Width Adjustment for digits 1, 2, 7 and 8 by GS1 spec is enabled. Default is False.

Declaration

public bool EanUpcAutoBWAfor1278DigitsEnabled { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

The GS1 spec states that for digits 1, 2, 7 or 8; the bars (dark bars) and spaces (light bars) are reduced or enlarged by one-thirteenth of a module (BarWidth) to provide a uniform distribution of bar width tolerances and thus improve scanning reliability.

EanUpcMagnificationFactor

Gets or sets the Magnification Factor for EAN/UPC barcodes. Default is 0 (Zero/Disabled).

Declaration

public float EanUpcMagnificationFactor { get; set; }

Property Value

Type	Description
System.Single

Remarks

EAN/UPC barcodes can be printed at various densities to accommodate a variety of printing and scanning processes. The significant dimensional parameter is X, the ideal width of a single module element. In Barcode Professional, this is specified with BarWidth property. For EAN/UPC symbols, the X-dimension at nominal size is 0.33 millimeter (= 0.013 inch). The "magnification factor" specifies the size of the barcode symbol as a whole by taking the nominal size as the 1.0 (100%) value.

EanUpcSupplement

Gets or sets the supplement type to use with EAN and UPC symbologies.

Declaration

public Supplement EanUpcSupplement { get; set; }

Property Value

Type	Description
Supplement

EanUpcSupplementCode

Gets or sets the supplement value for EAN and UPC symbologies.

Declaration

public string EanUpcSupplementCode { get; set; }

Property Value

Type	Description
System.String

EanUpcSupplementSeparation

Gets or sets the gap separation between the barcode and its supplement. The unit of measure must be specified to BarcodeUnit property.

Declaration

public double EanUpcSupplementSeparation { get; set; }

Property Value

Type	Description
System.Double

EanUpcSupplementTopMargin

Gets or sets the height of the margin above the EAN/UPC supplement bars. The unit of measure must be specified to BarcodeUnit property.

Declaration

public double EanUpcSupplementTopMargin { get; set; }

Property Value

Type	Description
System.Double

ErrorBehavior

Gets or sets what output type Barcode Professional will generate if an error occurs during barcode rendering. Default is BlankImage

Declaration

public ErrorBehavior ErrorBehavior { get; set; }

Property Value

Type	Description
ErrorBehavior

Extended

Gets or sets whether the extended versions for Code 39 and/or Code 93 symbologies must be used.

Declaration

public bool Extended { get; set; }

Property Value

Type	Description
System.Boolean

FitBarsAreaHeight

Gets or sets the desired height of the area that the barcode bars must fit. The unit of measure must be specified to BarcodeUnit property.

Declaration

public float FitBarsAreaHeight { get; set; }

Property Value

Type	Description
System.Single

FitBarsAreaWidth

Gets or sets the desired width of the area that the barcode bars must fit. The unit of measure must be specified to BarcodeUnit property.

Declaration

public float FitBarsAreaWidth { get; set; }

Property Value

Type	Description
System.Single

FitProportional

Gets or sets whether the barcode symbol is created by automatically calculating the bars or modules sizes so it fits the available area (Width - Height) proportinaly. Default is false.

Declaration

public bool FitProportional { get; set; }

Property Value

Type	Description
System.Boolean

Font

Gets or sets the font object associated with the barcode image.

Declaration

public Font Font { get; set; }

Property Value

Type	Description
System.Drawing.Font

FontBold

It indicates whether the Font object is bold.

Declaration

public bool FontBold { get; set; }

Property Value

Type	Description
System.Boolean

FontItalic

It indicates whether the Font object is italic.

Declaration

public bool FontItalic { get; set; }

Property Value

Type	Description
System.Boolean

FontName

Gets or sets the face name for the Font object to use.

Declaration

public string FontName { get; set; }

Property Value

Type	Description
System.String

FontSize

Gets or sets the em-size of the Font object measured in the unit of the Font object.

Declaration

public float FontSize { get; set; }

Property Value

Type	Description
System.Single

FontStrikeout

It indicates whether the Font object specifies a horizontal line through the font.

Declaration

public bool FontStrikeout { get; set; }

Property Value

Type	Description
System.Boolean

FontUnderline

It indicates whether the Font object is underlined.

Declaration

public bool FontUnderline { get; set; }

Property Value

Type	Description
System.Boolean

ForeColor

Gets or sets the foreground color of the barcode image.

Declaration

public Color ForeColor { get; set; }

Property Value

Type	Description
System.Drawing.Color

GS1DataStrictValidation

Gets or sets whether to strictly validate the specified GS1 Element Strings i.e. Application Identifier plus Data Field based on GS1 General Specifications rules. Default is false.

Declaration

public bool GS1DataStrictValidation { get; set; }

Property Value

Type	Description
System.Boolean

GuardBar

Gets or sets whether guard bars must be drawn.

Declaration

public bool GuardBar { get; set; }

Property Value

Type	Description
System.Boolean

GuardBarHeight

Gets or sets the guard bars' height. The unit of measure must be specified to BarcodeUnit property.

Declaration

public double GuardBarHeight { get; set; }

Property Value

Type	Description
System.Double

HanXinCodeByteEncodingName

Gets or sets the Encoding Name (Code Page) to be used for Han Xin Code Binary Byte Encoding mode. Default it ISO-8859-1.

Declaration

public string HanXinCodeByteEncodingName { get; set; }

Property Value

Type	Description
System.String

HanXinCodeEncoding

Gets or sets the Han Xin Code Encoding to use on that symbology.

Declaration

public HanXinCodeEncoding HanXinCodeEncoding { get; set; }

Property Value

Type	Description
HanXinCodeEncoding

HanXinCodeErrorCorrectionLevel

Gets or sets the Error Correction Level to apply for Han Xin Code symbology.

Declaration

public HanXinCodeErrorCorrectionLevel HanXinCodeErrorCorrectionLevel { get; set; }

Property Value

Type	Description
HanXinCodeErrorCorrectionLevel

HanXinCodeModuleSize

Gets or sets the module size. The unit of measure must be specified to BarcodeUnit property.

Declaration

public double HanXinCodeModuleSize { get; set; }

Property Value

Type	Description
System.Double

HanXinCodeProcessTilde

Gets or sets whether tilde character should be processed when Han Xin Code is being generated.

Declaration

public bool HanXinCodeProcessTilde { get; set; }

Property Value

Type	Description
System.Boolean

HanXinCodeVersion

Gets or sets the Han Xin Code Version to use on that symbology.

Declaration

public HanXinCodeVersion HanXinCodeVersion { get; set; }

Property Value

Type	Description
HanXinCodeVersion

Height

Gets or sets the barcode image's height to generate. The unit of measure must be specified to BarcodeUnit property.

Declaration

public double Height { get; set; }

Property Value

Type	Description
System.Double

HibcFormatHumanReadableText

Gets or sets whether the Human Readable Text is formatted as specified by HIBC Standards i.e. Zeros are displayed as Slashed-Zeros and the Space character is displayed as an Underscore.

Declaration

public bool HibcFormatHumanReadableText { get; set; }

Property Value

Type	Description
System.Boolean

HibcUseIsoIec15434Encoding

Gets or sets whether the ISO/IEC 15434 Protocol is used to encode the HIBC LIC or PAS Data Structures in 2D symbols. Default is False.

Declaration

public bool HibcUseIsoIec15434Encoding { get; set; }

Property Value

Type	Description
System.Boolean

HumanReadableText

Gets or sets the Human Readable Text to be displayed instead of the value to encode specified in the Code property.

Declaration

public string HumanReadableText { get; set; }

Property Value

Type	Description
System.String

ImageFormat

Gets or sets the image format for the barcode.

Declaration

public BarcodeImageFormat ImageFormat { get; set; }

Property Value

Type	Description
BarcodeImageFormat

IsbnSupplementCode

Gets or sets the supplement value for ISBN symbology. It generally is the suggested price.

Declaration

public string IsbnSupplementCode { get; set; }

Property Value

Type	Description
System.String

Isbt128DataStructure

Gets or sets the ISBT 128 Data Structure to be generated.

Declaration

public Isbt128DataStructure Isbt128DataStructure { get; set; }

Property Value

Type	Description
Isbt128DataStructure

Itf14LeftHMark

Gets or sets the H mark type for the left side of ITF-14 barcode symbol. Default is None.

Declaration

public ItfHmark Itf14LeftHMark { get; set; }

Property Value

Type	Description
ItfHmark

Itf14RightHMark

Gets or sets the H mark type for the right side of ITF-14 barcode symbol. Default is None.

Declaration

public ItfHmark Itf14RightHMark { get; set; }

Property Value

Type	Description
ItfHmark

JABCodeColors

Gets or sets the number of colors for JAB Code Symbol. Default is 8.

Declaration

public int JABCodeColors { get; set; }

Property Value

Type	Description
System.Int32

Remarks

The number of colors can be set to 2, 4, 8, 16, 32, 64, 128, or 256.

JABCodeModuleSize

Gets or sets the module size. The unit of measure must be specified to BarcodeUnit property.

Declaration

public double JABCodeModuleSize { get; set; }

Property Value

Type	Description
System.Double

JABCodeSymbolCount

Gets or sets the number of JAB Code Symbols to generate. Default it 1.

Declaration

public int JABCodeSymbolCount { get; set; }

Property Value

Type	Description
System.Int32

Remarks

JAB Code can be composed of a master symbol and many slave symbols. 61 is the maximum number of symbols.

JABCodeSymbolEccLevel

Gets or sets the Error Correction Code Level for each or all of the JAB Code Symbols. Default is an empty string which specifies an ECC Level 5.

Declaration

public string JABCodeSymbolEccLevel { get; set; }

Property Value

Type	Description
System.String

Remarks

The Error Correction Code levels range from 0 up to 10. If each JAB Code Symbol (in a master-slaves scenario) requires different ECC Levels, then it must be specified in a comma separated string. E.g. 8,4,5 means ECC Level 8 for master symbol and ECC Level 4 and 5 for first and second slave symbols respectively.

JABCodeSymbolPosition

Gets or sets the position for each or all of the JAB Code Symbols. Default is an empty string which specifies position 0 (center).

Declaration

public string JABCodeSymbolPosition { get; set; }

Property Value

Type	Description
System.String

Remarks

JAB Code may have arbitrary forms by cascading master and slave symbols in horizontal and vertical directions. JAB Slave symbols can be docked to the side of a master symbol or other slave symbols. In a master-slaves scenario, each JAB Code Symbol position or location must be specified in a comma separated string stating the Position Indexes (Refer to https://neodynamic.com/barcodes JAB Code page to learn more about Position Indexes). E.g. 0,3,2 means Position Index 0 for master symbol and Position Index 3 and Position Index 2 for first and second slave symbols respectively.

JABCodeSymbolVersion

Gets or sets the Version (Side size) for each or all of the JAB Code Symbols. Default is an empty string which specifies the minimum size.

Declaration

public string JABCodeSymbolVersion { get; set; }

Property Value

Type	Description
System.String

Remarks

A JAB Code Symbol can be of either square or rectangle form. JAB Code allows side Versions ranging from Version 1 (25 modules) up to Version 32 (145 modules). To specify a given side Version, a string must be specified in the format WxH where W is the horizonal side Version number and H is the vertical side Version Number. E.g. 4x4 would be a square JAB Symbol Version 4, 4x2 would be a rectangular JAB Symbol Version 4 (horizontal) and Version 2 (vertical). In a master-slaves scenario, if each JAB Code Symbol requires different side Versions, then it must be specified in a comma separated string. E.g. 4x4,4x2 means Version 8 for master symbol and Version 4 by Version 2 for the slave symbol.

LicenseKey

Gets or sets the license key. You must set this value in order to unlock the trial version.

Declaration

public string LicenseKey { get; set; }

Property Value

Type	Description
System.String

LicenseOwner

Gets or sets the license owner name. You must set this value in order to unlock the trial version.

Declaration

public string LicenseOwner { get; set; }

Property Value

Type	Description
System.String

MaxiCodeDrawPixelBasedSymbol

Gets or sets whether the MaxiCode symbol is drawn by using a Pixel Based method; otherwise, a Vector based method is used.

Declaration

public bool MaxiCodeDrawPixelBasedSymbol { get; set; }

Property Value

Type	Description
System.Boolean

MaxiCodeMode

Gets or sets the MaxiCode mode.

Declaration

public MaxiCodeModes MaxiCodeMode { get; set; }

Property Value

Type	Description
MaxiCodeModes

MaxiCodeProcessTilde

Gets or sets whether tilde character should be processed when MaxiCode code is being generated.

Declaration

public bool MaxiCodeProcessTilde { get; set; }

Property Value

Type	Description
System.Boolean

MaxiCodeSymbolCount

Gets or sets the number of MaxiCode symbols in a Structured Appended format. Its value must be less than or equal to 8.

Declaration

public int MaxiCodeSymbolCount { get; set; }

Property Value

Type	Description
System.Int32

MaxiCodeSymbolIndex

Gets or sets the Symbol Index for a Structured Appended MaxiCode. Its value must be 1 up to 8 and must be less than the value in MaxiCodeSymbolCount property.

Declaration

public int MaxiCodeSymbolIndex { get; set; }

Property Value

Type	Description
System.Int32

MICRCharHeight

Gets or sets the height of the MICR characters. The unit of measure must be specified to BarcodeUnit property.

Declaration

public double MICRCharHeight { get; set; }

Property Value

Type	Description
System.Double

MICRCharSpacing

Gets or sets the gap spacing between each MICR character specified in the Code property. It must be a comma separated list of float point numbers (in InvariantCulture) specifying the desired spacing between each MICR char. The unit of measure must be specified to BarcodeUnit property IMPORTANT: Spacing is the distance between the right average edge of adjacent characters.

Declaration

public string MICRCharSpacing { get; set; }

Property Value

Type	Description
System.String

MICRCharWidths

Gets or sets the widths of each MICR character specified in the Code property. It must be a comma separated list of float point numbers (in InvariantCulture) specifying the desired width of each MICR char. The unit of measure must be specified to BarcodeUnit property.

Declaration

public string MICRCharWidths { get; set; }

Property Value

Type	Description
System.String

MicroPdf417Version

Gets or sets the MicroPDF417 version (a predefined combinations of numbers of columns and rows) to be generated.

Declaration

public MicroPdf417Version MicroPdf417Version { get; set; }

Property Value

Type	Description
MicroPdf417Version

MicroQRCodeVersion

Gets or sets the Micro QR Code Version to use on that symbology.

Declaration

public MicroQRCodeVersion MicroQRCodeVersion { get; set; }

Property Value

Type	Description
MicroQRCodeVersion

Monochrome

Gets or sets a value indicating whether the barcode image must be converted to monochrome a.k.a. Black and White 1 bit per pixel format.

Declaration

public bool Monochrome { get; set; }

Property Value

Type	Description
System.Boolean

MsiChecksum

Gets or sets the checksum mode to be used on MSI symbology.

Declaration

public MsiChecksum MsiChecksum { get; set; }

Property Value

Type	Description
MsiChecksum

Pdf417AspectRatio

Gets or sets the ratio of the height to the overall width of the PDF417 symbol. Its value must be 0 (zero) up to 1 (one).

Declaration

public double Pdf417AspectRatio { get; set; }

Property Value

Type	Description
System.Double

Pdf417ByteEncodingName

Gets or sets the Encoding Name (Code Page) to be used for PDF417 Byte Compaction mode. Default it ISO-8859-1.

Declaration

public string Pdf417ByteEncodingName { get; set; }

Property Value

Type	Description
System.String

Pdf417Columns

Gets or sets the number of columns to use for PDF417 symbology.

Declaration

public int Pdf417Columns { get; set; }

Property Value

Type	Description
System.Int32

Pdf417CompactionType

Gets or sets the Compaction Type to apply for PDF417 symbology.

Declaration

public Pdf417CompactionType Pdf417CompactionType { get; set; }

Property Value

Type	Description
Pdf417CompactionType

Pdf417ErrorCorrectionLevel

Gets or sets the Error Correction Level to apply for PDF417 symbology.

Declaration

public Pdf417ErrorCorrection Pdf417ErrorCorrectionLevel { get; set; }

Property Value

Type	Description
Pdf417ErrorCorrection

Pdf417FileId

Gets or sets the File ID of the Macro PDF417 symbol. Its value must be a sequence of codewords (Each codeword value must be a number between 000 and 899) and must be the same for all data segments.

Declaration

public string Pdf417FileId { get; set; }

Property Value

Type	Description
System.String

Pdf417Rows

Gets or sets the number of rows to use for PDF417 symbology.

Declaration

public int Pdf417Rows { get; set; }

Property Value

Type	Description
System.Int32

Pdf417SegmentCount

Gets or sets the number of Macro PDF417 symbols. Its value must be less than or equal to 99999.

Declaration

public int Pdf417SegmentCount { get; set; }

Property Value

Type	Description
System.Int32

Pdf417SegmentIndex

Gets or sets the Segment Index for a Macro PDF417 symbol. Its value must be 0 (zero) up to 99998 and must be less than the value in Pdf417SegmentCount property.

Declaration

public int Pdf417SegmentIndex { get; set; }

Property Value

Type	Description
System.Int32

Pdf417Truncated

Gets or sets whether the right side of PDF417 barcode is truncated (removed).

Declaration

public bool Pdf417Truncated { get; set; }

Property Value

Type	Description
System.Boolean

Pharmacode2DColorField1

Gets or sets the Pharmacode 2D Color Field 1. Default is RGB 94, 156, 62.

Declaration

public Color Pharmacode2DColorField1 { get; set; }

Property Value

Type	Description
System.Drawing.Color

Pharmacode2DColorField2

Gets or sets the Pharmacode 2D Color Field 2. Default is RGB 184, 64, 39.

Declaration

public Color Pharmacode2DColorField2 { get; set; }

Property Value

Type	Description
System.Drawing.Color

Pharmacode2DColorField3

Gets or sets the Pharmacode 2D Color Field 3. Default is RGB 73, 122, 195.

Declaration

public Color Pharmacode2DColorField3 { get; set; }

Property Value

Type	Description
System.Drawing.Color

Pharmacode2DColorField4

Gets or sets the Pharmacode 2D Color Field 4. Default is RGB 240, 235, 4.

Declaration

public Color Pharmacode2DColorField4 { get; set; }

Property Value

Type	Description
System.Drawing.Color

Pharmacode2DColorField5

Gets or sets the Pharmacode 2D Color Field 5. Default is RGB 40, 35, 116.

Declaration

public Color Pharmacode2DColorField5 { get; set; }

Property Value

Type	Description
System.Drawing.Color

Pharmacode2DColorField6

Gets or sets the Pharmacode 2D Color Field 6. Default is RGB 152, 194, 161.

Declaration

public Color Pharmacode2DColorField6 { get; set; }

Property Value

Type	Description
System.Drawing.Color

Pharmacode2DColorField7

Gets or sets the Pharmacode 2D Color Field 7. Default is RGB 203, 128, 28.

Declaration

public Color Pharmacode2DColorField7 { get; set; }

Property Value

Type	Description
System.Drawing.Color

Pharmacode2DColorField8

Gets or sets the Pharmacode 2D Color Field 8. Default is RGB 122, 46, 120.

Declaration

public Color Pharmacode2DColorField8 { get; set; }

Property Value

Type	Description
System.Drawing.Color

Pharmacode2DColorFields

Gets or sets the 2D-Pharmacode Color Fields type. Default is Standard.

Declaration

public Pharmacode2DColorFields Pharmacode2DColorFields { get; set; }

Property Value

Type	Description
Pharmacode2DColorFields

Pharmacode2DTriggerMark

Gets or sets whether to display the 2D-Pharmacode Trigger Mark and its location. Default is Left.

Declaration

public Pharmacode2DTriggerMark Pharmacode2DTriggerMark { get; set; }

Property Value

Type	Description
Pharmacode2DTriggerMark

PharmacodeBarsSpacing

Gets or sets the gap between Pharmacode bars.

Declaration

public double PharmacodeBarsSpacing { get; set; }

Property Value

Type	Description
System.Double

PharmacodeThickBarWidth

Gets or sets the width of Pharmacode Thick Bars.

Declaration

public double PharmacodeThickBarWidth { get; set; }

Property Value

Type	Description
System.Double

PharmacodeThinBarWidth

Gets or sets the width of Pharmacode Thin Bars.

Declaration

public double PharmacodeThinBarWidth { get; set; }

Property Value

Type	Description
System.Double

PlanetHeightShortBar

Gets or sets the short bars' height of Planet symbology. The unit of measure must be specified to BarcodeUnit property.

Declaration

public double PlanetHeightShortBar { get; set; }

Property Value

Type	Description
System.Double

PlanetHeightTallBar

Gets or sets the tall bars' height of Planet symbology. The unit of measure must be specified to BarcodeUnit property.

Declaration

public double PlanetHeightTallBar { get; set; }

Property Value

Type	Description
System.Double

Postal4StateAddStartStopChar

Gets or sets whether start and stop characters must be added and drawn in the barcode image.

Declaration

public bool Postal4StateAddStartStopChar { get; set; }

Property Value

Type	Description
System.Boolean

Postal4StateBarsSpacing

Gets or sets the gap spacing between bars. The unit of measure must be specified to BarcodeUnit property.

Declaration

public double Postal4StateBarsSpacing { get; set; }

Property Value

Type	Description
System.Double

Postal4StateTrackerBarHeight

Gets or sets the tracker bar's height. The unit of measure must be specified to BarcodeUnit property.

Declaration

public double Postal4StateTrackerBarHeight { get; set; }

Property Value

Type	Description
System.Double

Postal4StateTrackerBarWidth

Gets or sets the tracker bar's width. The unit of measure must be specified to BarcodeUnit property.

Declaration

public double Postal4StateTrackerBarWidth { get; set; }

Property Value

Type	Description
System.Double

PostnetHeightShortBar

Gets or sets the short bars' height of Postnet symbology. The unit of measure must be specified to BarcodeUnit property.

Declaration

public double PostnetHeightShortBar { get; set; }

Property Value

Type	Description
System.Double

PostnetHeightTallBar

Gets or sets the tall bars' height of Postnet symbology. The unit of measure must be specified to BarcodeUnit property.

Declaration

public double PostnetHeightTallBar { get; set; }

Property Value

Type	Description
System.Double

QRCodeByteEncodingName

Gets or sets the Encoding Name (Code Page) to be used for QR Code Byte Compaction mode. Default it ISO-8859-1.

Declaration

public string QRCodeByteEncodingName { get; set; }

Property Value

Type	Description
System.String

QRCodeEncoding

Gets or sets the QR Code Encoding to use on that symbology.

Declaration

public QRCodeEncoding QRCodeEncoding { get; set; }

Property Value

Type	Description
QRCodeEncoding

QRCodeErrorCorrectionLevel

Gets or sets the Error Correction Level to apply for QR Code symbology.

Declaration

public QRCodeErrorCorrectionLevel QRCodeErrorCorrectionLevel { get; set; }

Property Value

Type	Description
QRCodeErrorCorrectionLevel

QRCodeMask

Gets or sets the QR Code Mask pattern to use on that symbology. Default is Auto.

Declaration

public QRCodeMask QRCodeMask { get; set; }

Property Value

Type	Description
QRCodeMask

QRCodeModuleSize

Gets or sets the module size. The unit of measure must be specified to BarcodeUnit property.

Declaration

public double QRCodeModuleSize { get; set; }

Property Value

Type	Description
System.Double

QRCodeProcessTilde

Gets or sets whether tilde character should be processed when QR Code is being generated.

Declaration

public bool QRCodeProcessTilde { get; set; }

Property Value

Type	Description
System.Boolean

QRCodeVersion

Gets or sets the QR Code Version to use on that symbology.

Declaration

public QRCodeVersion QRCodeVersion { get; set; }

Property Value

Type	Description
QRCodeVersion

QuietZoneWidth

Gets or sets the quiet zone's width. The unit of measure must be specified to BarcodeUnit property.

Declaration

public double QuietZoneWidth { get; set; }

Property Value

Type	Description
System.Double

RectMicroQRCodeVersion

Gets or sets the Rectangular Micro QR Code Version to use on that symbology.

Declaration

public RectMicroQRCodeVersion RectMicroQRCodeVersion { get; set; }

Property Value

Type	Description
RectMicroQRCodeVersion

Rotate

Gets or sets the rotation angle to apply on the barcode image.

Declaration

public Rotate Rotate { get; set; }

Property Value

Type	Description
Rotate

SegmentsPerRow

Gets or sets the number of segments per row to be used in GS1 DataBar Expanded Stacked or RSS Expanded Stacked symbologies. It must be an even number ranging from 2 up to 22. Default is 4.

Declaration

public int SegmentsPerRow { get; set; }

Property Value

Type	Description
System.Int32

SnapsToDevicePixels

Gets or sets a value that determines whether barcode drawing should use device-specific pixel settings during rendering. Default value is false.

Declaration

public bool SnapsToDevicePixels { get; set; }

Property Value

Type	Description
System.Boolean

Symbology

Gets or sets the barcode symbology to generate.

Declaration

public Symbology Symbology { get; set; }

Property Value

Type	Description
Symbology

TelepenEncoding

Gets or sets the Telepen Encoding to use on that symbology.

Declaration

public TelepenEncoding TelepenEncoding { get; set; }

Property Value

Type	Description
TelepenEncoding

Text

Gets or sets the additional text to show in the barcode image e.g.: Client ID. Note: This is not the value to encode.

Declaration

public string Text { get; set; }

Property Value

Type	Description
System.String

TextAlignment

Gets or sets the text alignment for Text property.

Declaration

public Alignment TextAlignment { get; set; }

Property Value

Type	Description
Alignment

TextFormatPattern

Gets or sets the string pattern to format the Text property. Based on String.Format(). Default value is empty (Disabled).

Declaration

public string TextFormatPattern { get; set; }

Property Value

Type	Description
System.String

Tlc39MicroPdf417BarWidth

Gets or sets the narrow bar width for TLC39's MicroPdf417 symbol. The unit of measure must be specified to BarcodeUnit property.

Declaration

public double Tlc39MicroPdf417BarWidth { get; set; }

Property Value

Type	Description
System.Double

Tlc39MicroPdf417RowBarHeight

Gets or sets the row bar height for TLC39's MicroPdf417 symbol. The unit of measure must be specified to BarcodeUnit property.

Declaration

public double Tlc39MicroPdf417RowBarHeight { get; set; }

Property Value

Type	Description
System.Double

TopMargin

Gets or sets the height of the margin above the barcode bars. The unit of measure must be specified to BarcodeUnit property.

Declaration

public double TopMargin { get; set; }

Property Value

Type	Description
System.Double

UltracodeErrorCorrection

Gets or sets the Error Correction Code Level for Ultracode Symbol. Default ECC Level 2.

Declaration

public UltracodeErrorCorrection UltracodeErrorCorrection { get; set; }

Property Value

Type	Description
UltracodeErrorCorrection

UltracodeModuleSize

Gets or sets the Ultracode module size. The unit of measure must be specified to BarcodeUnit property.

Declaration

public double UltracodeModuleSize { get; set; }

Property Value

Type	Description
System.Double

UpcESystem

Gets or sets the number system to use for UPC-E symbology.

Declaration

public UpcE UpcESystem { get; set; }

Property Value

Type	Description
UpcE

UseQuietZoneForText

Gets or sets whether quiet zones are used for drawing Text and/or Code properties.

Declaration

public bool UseQuietZoneForText { get; set; }

Property Value

Type	Description
System.Boolean

UspsFimPattern

Gets or sets the USPS FIM pattern to use on that symbology.

Declaration

public FIM UspsFimPattern { get; set; }

Property Value

Type	Description
FIM

UspsHorizontalBarsCount

Gets or sets the number of horizontal bars to be drawn.

Declaration

public int UspsHorizontalBarsCount { get; set; }

Property Value

Type	Description
System.Int32

Width

Gets or sets the barcode image's width to generate. The unit of measure must be specified to BarcodeUnit property.

Declaration

public double Width { get; set; }

Property Value

Type	Description
System.Double

Methods

Dispose()

Declaration

public void Dispose()

Implements

System.IDisposable.Dispose()

GetBarcodeImage()

Gets a byte array representation of the barcode image in the image format specified in the ImageFormat property (Default value is Bmp).

Declaration

public byte[] GetBarcodeImage()

Returns

Type	Description
System.Byte[]	A byte array representation of the barcode image.

GetBarcodeImageBmp()

Gets a byte array representation of the barcode image in BMP format.

Declaration

public byte[] GetBarcodeImageBmp()

Returns

Type	Description
System.Byte[]	A byte array representation of the barcode image in BMP format.

GetBarcodeImageGif()

Gets a byte array representation of the barcode image in GIF format.

Declaration

public byte[] GetBarcodeImageGif()

Returns

Type	Description
System.Byte[]	A byte array representation of the barcode image in GIF format.

GetBarcodeImageJpeg()

Gets a byte array representation of the barcode image in JPEG format.

Declaration

public byte[] GetBarcodeImageJpeg()

Returns

Type	Description
System.Byte[]	A byte array representation of the barcode image in JPEG format.

GetBarcodeImagePng()

Gets a byte array representation of the barcode image in PNG format.

Declaration

public byte[] GetBarcodeImagePng()

Returns

Type	Description
System.Byte[]	A byte array representation of the barcode image in PNG format.

GetColor(Int32)

Creates a System.Drawing.Color structure from a 32-bit ARGB value.

Declaration

public Color GetColor(int argb)

Parameters

Type	Name	Description
System.Int32	argb	A value specifying the 32-bit ARGB value.

Returns

Type	Description
System.Drawing.Color	The System.Drawing.Color structure that this method creates.

GetColor(Int32, Int32, Int32)

Creates a System.Drawing.Color structure from the specified 8-bit color values (red, green, and blue). The alpha value is implicitly 255 (fully opaque). Although this method allows a 32-bit value to be passed for each color component, the value of each component is limited to 8 bits.

Declaration

public Color GetColor(int red, int green, int blue)

Parameters

Type	Name	Description
System.Int32	red	The red component value for the new System.Drawing.Color structure. Valid values are 0 through 255.
System.Int32	green	The green component value for the new System.Drawing.Color structure. Valid values are 0 through 255.
System.Int32	blue	The blue component value for the new System.Drawing.Color structure. Valid values are 0 through 255.

Returns

Type	Description
System.Drawing.Color	The System.Drawing.Color structure that this method creates.

GetColor(Int32, Int32, Int32, Int32)

Creates a System.Drawing.Color structure from the four ARGB component (alpha, red, green, and blue) values. Although this method allows a 32-bit value to be passed for each component, the value of each component is limited to 8 bits.

Declaration

public Color GetColor(int alpha, int red, int green, int blue)

Parameters

Type	Name	Description
System.Int32	alpha	The alpha component value for the new System.Drawing.Color structure. Valid values are 0 through 255.
System.Int32	red	The red component value for the new System.Drawing.Color structure. Valid values are 0 through 255.
System.Int32	green	The green component value for the new System.Drawing.Color structure. Valid values are 0 through 255.
System.Int32	blue	The blue component value for the new System.Drawing.Color structure. Valid values are 0 through 255.

Returns

Type	Description
System.Drawing.Color	The System.Drawing.Color structure that this method creates.

GetColor(String)

Gets a System.Drawing.Color structure from the specified name of a pre-defined color.

Declaration

public Color GetColor(string name)

Parameters

Type	Name	Description
System.String	name	A string that is the name of a pre-defined color. Valid names are the same as the names of the elements of the System.Drawing.KnownColor enumeration.

Returns

Type	Description
System.Drawing.Color	The System.Drawing.Color structure that this method creates.

SetBackColor(String)

Sets the BackColor property to the specified HTML Color

Declaration

public void SetBackColor(string htmlColor)

Parameters

Type	Name	Description
System.String	htmlColor	The HTML Color

SetBarColor(String)

Sets the BarColor property to the specified HTML Color

Declaration

public void SetBarColor(string htmlColor)

Parameters

Type	Name	Description
System.String	htmlColor	The HTML Color

SetBorderColor(String)

Sets the BorderColor property to the specified HTML Color

Declaration

public void SetBorderColor(string htmlColor)

Parameters

Type	Name	Description
System.String	htmlColor	The HTML Color

SetForeColor(String)

Sets the ForeColor property to the specified HTML Color

Declaration

public void SetForeColor(string htmlColor)

Parameters

Type	Name	Description
System.String	htmlColor	The HTML Color