Class BarcodeItem

Represents a barcode item. It can draw linear (1D), Postal and 2D barcodes.

Inheritance
System.Object
Item
BarcodeItem
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.SDK.Printing
Assembly: cs.temp.dll.dll
Syntax
public class BarcodeItem : Item, IXmlTemplate, INotifyPropertyChanged

Constructors

BarcodeItem()

Initializes a new instance of the BarcodeItem class.

Declaration
public BarcodeItem()

BarcodeItem(Double, Double, Double, Double, BarcodeSymbology, String)

Initializes a new instance of the BarcodeItem class with the specified location, barcode symbology and value to encode.

Declaration
public BarcodeItem(double x, double y, double width, double height, BarcodeSymbology symbology, string code)
Parameters
Type Name Description
System.Double x

The x-coordinate of the upper-left corner of the item relative to the upper-left corner of its container.
System.Double y

The y-coordinate of the upper-left corner of the item relative to the upper-left corner of its container.
System.Double width

The width of the item container.
System.Double height

The height of the item container.
BarcodeSymbology symbology

The barcode symbology/standard to be generated.
System.String code

The value to encode.

Fields

AI2

Special character used to specify that an Application Identifier (AI) is 2-digits long. Used by GS1-128 and UCC/EAN-128 barcodes.

Declaration
public const char AI2 = 'Ê'
Field Value
Type Description
System.Char

AI3

Special character used to specify that an Application Identifier (AI) is 3-digits long. Used by GS1-128 and UCC/EAN-128 barcodes.

Declaration
public const char AI3 = 'Ë'
Field Value
Type Description
System.Char

AI4

Special character used to specify that an Application Identifier (AI) is 4-digits long. Used by GS1-128 and UCC/EAN-128 barcodes.

Declaration
public const char AI4 = 'Ì'
Field Value
Type Description
System.Char

AI5

Special character used to specify that an Application Identifier (AI) is 5-digits long. Used by GS1-128 and UCC/EAN-128 barcodes.

Declaration
public const char AI5 = 'Í'
Field Value
Type Description
System.Char

CODE128_FNC1

Function 1 Symbol Character (FNC1) used by Code 128 barcodes.

Declaration
public const char CODE128_FNC1 = 'Ĭ'
Field Value
Type Description
System.Char

CODE128_FNC2

Function 2 Symbol Character (FNC2) used by Code 128 barcodes.

Declaration
public const char CODE128_FNC2 = 'ĭ'
Field Value
Type Description
System.Char

CODE128_FNC3

Function 3 Symbol Character (FNC3) used by Code 128 barcodes.

Declaration
public const char CODE128_FNC3 = 'Į'
Field Value
Type Description
System.Char

CODE128_FNC4

Function 4 Symbol Character (FNC4) used by Code 128 barcodes.

Declaration
public const char CODE128_FNC4 = 'į'
Field Value
Type Description
System.Char

EOT

End Of Transmission character (ASCII 4).

Declaration
public const char EOT = '\u0004'
Field Value
Type Description
System.Char

FNC1

Function 1 Symbol Character (FNC1) used by GS1-128 and UCC/EAN-128 barcodes.

Declaration
public const char FNC1 = 'È'
Field Value
Type Description
System.Char

GS

Group Separator character (ASCII 29).

Declaration
public const char GS = '\u001d'
Field Value
Type Description
System.Char

RS

Record Separator character (ASCII 30).

Declaration
public const char RS = '\u001e'
Field Value
Type Description
System.Char

Properties

AddChecksum

Gets or sets whether checksum must be calculated and attached to the value to encode. Default value is true

Declaration
public bool AddChecksum { get; set; }
Property Value
Type Description
System.Boolean

AztecCodeByteEncodingName

Gets or sets the Encoding Name (Code Page) to be used for Aztec Code symbology. Default value is "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 value 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. Default value is Auto

Declaration
public AztecCodeFormat AztecCodeFormat { get; set; }
Property Value
Type Description
AztecCodeFormat

AztecCodeModuleSize

Gets or sets the Aztec Code module size. The module is each indivual black square which composes the whole of Aztec Code symbol. Default value is 0.0417

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. Default value is false

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. Default value is -1 (disabled)

Declaration
public int AztecCodeRune { get; set; }
Property Value
Type Description
System.Int32

BackColor

Gets or sets the background color of the barcode. Default value is White

Declaration
public Color BackColor { get; set; }
Property Value
Type Description
Color

BackColorHex

Gets or sets the background color of the barcode in hex notation.

Declaration
public string BackColorHex { get; set; }
Property Value
Type Description
System.String
Remarks

The Color Hex notation is as follows #[AA]RRGGBB where A, R, G, B refers to Aplha, Red, Green and Blue pixels. The following options would also be valid: #RGB or #ARGB (in this short format all channel values must be the same), #RRGGBB or #AARRGGBB.

BarcodeAlignment

Gets or sets the barcode alignment. Default value is TopLeft

Declaration
public BarcodeAlignment BarcodeAlignment { get; set; }
Property Value
Type Description
BarcodeAlignment

BarcodePadding

Gets or sets the amount of space between the container's border and the barcode content. The barcode padding is used only when Sizing property is set up to Fill. Default value is 0 (zero)

Declaration
public FrameThickness BarcodePadding { get; set; }
Property Value
Type Description
FrameThickness

BarColor

Gets or sets the bars' color of the barcode. Default value is Black.

Declaration
public Color BarColor { get; set; }
Property Value
Type Description
Color

BarColorHex

Gets or sets the bars' background color in hex notation.

Declaration
public string BarColorHex { get; set; }
Property Value
Type Description
System.String
Remarks

The Color Hex notation is as follows #[AA]RRGGBB where A, R, G, B refers to Aplha, Red, Green and Blue pixels. The following options would also be valid: #RGB or #ARGB (in this short format all channel values must be the same), #RRGGBB or #AARRGGBB.

BarHeight

Gets or sets the bars' height of the barcode. Default value is 0.5

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. Default value is 2

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. Default value is 0.0104

Declaration
public double BarWidth { get; set; }
Property Value
Type Description
System.Double

BarWidthAdjustment

Gets or sets the Bar Width Adjustment. Default value is 0 (zero)

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. Bearer bar is only available for 2 of 5, Code 128 and UCC.EAN 128 barcodes. Default value is None

Declaration
public BearerBarStyle BearerBarStyle { get; set; }
Property Value
Type Description
BearerBarStyle

BearerBarThickness

Gets or sets the bearer bars' thickness. Default value is 0.05

Declaration
public double BearerBarThickness { get; set; }
Property Value
Type Description
System.Double

BorderColor

Gets or sets the color of the border of the rectangle container. Default value is Black

Declaration
public Color BorderColor { get; set; }
Property Value
Type Description
Color

BorderColorHex

Gets or sets the color of the border of the rectangle container in hex notation.

Declaration
public string BorderColorHex { get; set; }
Property Value
Type Description
System.String
Remarks

The Color Hex notation is as follows #[AA]RRGGBB where A, R, G, B refers to Aplha, Red, Green and Blue pixels. The following options would also be valid: #RGB or #ARGB (in this short format all channel values must be the same), #RRGGBB or #AARRGGBB.

BorderThickness

Gets or sets the thickness for each side of the rectangle container. Default value is 0 (zero)

Declaration
public FrameThickness BorderThickness { get; set; }
Property Value
Type Description
FrameThickness

CodabarStartChar

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

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. Default value is A

Declaration
public CodabarStartStopChar CodabarStopChar { get; set; }
Property Value
Type Description
CodabarStartStopChar

Code

Gets or sets the value to encode. Default value is "1234567890"

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. Default value is Auto

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. Default value is Mode1

Declaration
public Code16k Code16kMode { get; set; }
Property Value
Type Description
Code16k

Code39FullAsciiMode

Gets or sets whether the Full ASCII mode (a.k.a. Extended version) for Code 39 symbology should be used. Default value is true

Declaration
public bool Code39FullAsciiMode { get; set; }
Property Value
Type Description
System.Boolean

Code93FullAsciiMode

Gets or sets whether the Full ASCII mode (a.k.a. Extended version) for Code 93 symbology should be used. Default value is true

Declaration
public bool Code93FullAsciiMode { get; set; }
Property Value
Type Description
System.Boolean

CodeAlignment

Gets or sets the text alignment for Code property. Default value is BelowCenter

Declaration
public BarcodeTextAlignment CodeAlignment { get; set; }
Property Value
Type Description
BarcodeTextAlignment

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

CornerRadius

Gets or sets the radii of a rectangle's corners. Default value is 0 (zero)

Declaration
public RectangleCornerRadius CornerRadius { get; set; }
Property Value
Type Description
RectangleCornerRadius

CounterStep

Gets or sets the step for the counter. The counter will increase (positive) or decrease (negative) by this number on every printed label. Default value is 0 (zero)

Declaration
public int CounterStep { get; set; }
Property Value
Type Description
System.Int32

CounterUseLeadingZeros

Gets or sets whether leading zeros are printed or suppressed when using counters. Default value is false

Declaration
public bool CounterUseLeadingZeros { get; set; }
Property Value
Type Description
System.Boolean

DataMatrixByteEncodingName

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

Declaration
public string DataMatrixByteEncodingName { get; set; }
Property Value
Type Description
System.String

DataMatrixEncoding

Gets or sets the Data Matrix Encoding to use on that symbology. Default value is Auto

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. Default value is "001001"

Declaration
public string DataMatrixFileId { get; set; }
Property Value
Type Description
System.String

DataMatrixFormat

Gets or sets the Data Matrix Format to use on that symbology. Default value is Auto

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 Data Matrix module size. The module is each indivual black square which composes the whole of Data Matrix symbol. Default value is 0.0417

Declaration
public double DataMatrixModuleSize { get; set; }
Property Value
Type Description
System.Double

DataMatrixProcessTilde

Gets or sets whether tilde character '~' should be processed when Data Matrix code is being generated. Default value is false

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. Default value is 1

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. Default value is 1

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 on the barcode. Default value is true

Declaration
public bool DisplayChecksum { get; set; }
Property Value
Type Description
System.Boolean

DisplayCode

Gets or sets whether the value to encode must be displayed on the barcode. Default value is true

Declaration
public bool DisplayCode { get; set; }
Property Value
Type Description
System.Boolean

DisplayStartStopChar

Gets or sets whether start and stop characters must be displayed on the barcode. Default value is true

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. Default value is 0.0417

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. Default value is false

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

EanUpcDisplayLightMarginIndicator

Gets or sets whether light margin indicators must be displayed in the EAN/UPC barcodes. Default value is false

Declaration
public bool EanUpcDisplayLightMarginIndicator { get; set; }
Property Value
Type Description
System.Boolean

EanUpcGuardBar

Gets or sets whether guard bars must be drawn for EAN and UPC symbologies. Default value is true

Declaration
public bool EanUpcGuardBar { get; set; }
Property Value
Type Description
System.Boolean

EanUpcGuardBarHeight

Gets or sets the guard bars' height. In general, this value should be a bit greater than the BarHeight property. Default value is 0.55

Declaration
public double EanUpcGuardBarHeight { get; set; }
Property Value
Type Description
System.Double

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. Default value is None

Declaration
public Supplement EanUpcSupplement { get; set; }
Property Value
Type Description
Supplement

EanUpcSupplementCode

Gets or sets the supplement value for EAN and UPC symbologies. Default value is "0"

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. Default value is 0.15

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. Default value is 0.15

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 BarcodeErrorBehavior ErrorBehavior { get; set; }
Property Value
Type Description
BarcodeErrorBehavior

Font

Gets the Font object for the value to encode i.e. the Code property. Default value is NativePrinterFontA, 10pt

Declaration
public Font Font { get; }
Property Value
Type Description
Font

ForeColor

Gets or sets the foreground color of the value to encode. Default value is Black

Declaration
public Color ForeColor { get; set; }
Property Value
Type Description
Color

ForeColorHex

Gets or sets the foreground color of the value to encode in hex notation.

Declaration
public string ForeColorHex { get; set; }
Property Value
Type Description
System.String
Remarks

The Color Hex notation is as follows #[AA]RRGGBB where A, R, G, B refers to Aplha, Red, Green and Blue pixels. The following options would also be valid: #RGB or #ARGB (in this short format all channel values must be the same), #RRGGBB or #AARRGGBB.

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

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. Default value is Auto

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. Default value is L1

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. Default value is 0.0417

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. Default value is false

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. Default value is Auto

Declaration
public HanXinCodeVersion HanXinCodeVersion { get; set; }
Property Value
Type Description
HanXinCodeVersion

HasFixedContent

Declaration
protected override bool HasFixedContent { get; }
Property Value
Type Description
System.Boolean
Overrides

Height

Gets or sets the height of the rectangle container. Default value is 0.5

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. Default value is true

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

HideIfEmpty

Gets or sets whether the barcode symbol is not displayed or printed if the value to encode is empty. Default value is false

Declaration
public bool HideIfEmpty { 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. Default value is an empty string

Declaration
public string HumanReadableText { get; set; }
Property Value
Type Description
System.String

Isbt128DataStructure

Gets or sets the ISBT 128 Data Structure to be generated. Default value is DS001

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

Mask

Gets or sets the input Mask for the value to encode. Default value is an empty string

  • D or d: Decimal numeric 0-9
  • H or h: Hexadecimal 0-9 plus a-f or A-F
  • O or o: Octal 0-7
  • A or a: Alphabetic A-Z or a-z
  • N or n: Alphanumeric 0-9 plus A-Z or a-z
  • %: Ignore character or skip

Declaration
public string Mask { get; set; }
Property Value
Type Description
System.String
Remarks

The length of the mask defines the number of characters to be formatted or masked. The mask is aligned to the characters in the target string starting with the right-most position.

MaskIncrement

Gets or sets the mask increment. The increment is the value to be added to the value to encode on each label to be printed. Default value is an empty string

Declaration
public string MaskIncrement { get; set; }
Property Value
Type Description
System.String
Remarks

The default value for the increment is equivalent to a decimal value of 1 (one). The string is composed of any characters defined in the input mask. Invalid characters are assumed to be equal to a value of 0 (zero) in that characters position.

The increment value for alphabetic strings start with 'A' or 'a' as the zero placeholder. This means to increment an alphabetic character by one, a value of 'B' or 'b' must be in the increment string.

For characters that do not get incremented, the '%' character needs to be added to the increment string.

MaxiCodeDrawPixelBasedSymbol

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

Declaration
public bool MaxiCodeDrawPixelBasedSymbol { get; set; }
Property Value
Type Description
System.Boolean

MaxiCodeMode

Gets or sets the MaxiCode mode. Default value is Mode4

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. Default value is false

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. Default value is 1

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. Default value is 1

Declaration
public int MaxiCodeSymbolIndex { get; set; }
Property Value
Type Description
System.Int32

MicroPdf417Version

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

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. Default value is Auto

Declaration
public MicroQRCodeVersion MicroQRCodeVersion { get; set; }
Property Value
Type Description
MicroQRCodeVersion

MsiChecksum

Gets or sets the checksum mode to be used on MSI symbology. Default value is OneMod10

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). Default value is 0 (zero)

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 value is "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. Default value is (Auto)

Declaration
public int Pdf417Columns { get; set; }
Property Value
Type Description
System.Int32

Pdf417CompactionType

Gets or sets the Compaction Type to apply for PDF417 symbology. Default value is Auto

Declaration
public Pdf417CompactionType Pdf417CompactionType { get; set; }
Property Value
Type Description
Pdf417CompactionType

Pdf417ErrorCorrectionLevel

Gets or sets the Error Correction Level to apply for PDF417 symbology. Default value is Level2

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. Default value is "000"

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. Default value is 0 (Auto)

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. Default value is 0 (zero)

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. Default value is 0 (zero)

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). Default value is false

Declaration
public bool Pdf417Truncated { get; set; }
Property Value
Type Description
System.Boolean

PharmacodeBarsSpacing

Gets or sets the gap between Pharmacode bars. Default value is 0.0417

Declaration
public double PharmacodeBarsSpacing { get; set; }
Property Value
Type Description
System.Double

PharmacodeThickBarWidth

Gets or sets the width of Pharmacode Thick Bars. Default value is 0.0625

Declaration
public double PharmacodeThickBarWidth { get; set; }
Property Value
Type Description
System.Double

PharmacodeThinBarWidth

Gets or sets the width of Pharmacode Thin Bars. Default value is 0.0208

Declaration
public double PharmacodeThinBarWidth { get; set; }
Property Value
Type Description
System.Double

PlanetHeightShortBar

Gets or sets the short bars' height of Planet symbology. Default value is 0.1

Declaration
public double PlanetHeightShortBar { get; set; }
Property Value
Type Description
System.Double

PlanetHeightTallBar

Gets or sets the tall bars' height of Planet symbology. Default value is 0.2

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 on the barcode. Default value is true

Declaration
public bool Postal4StateAddStartStopChar { get; set; }
Property Value
Type Description
System.Boolean

Postal4StateBarsSpacing

Gets or sets the gap spacing between bars. Default value is 0.0313

Declaration
public double Postal4StateBarsSpacing { get; set; }
Property Value
Type Description
System.Double

Postal4StateTrackerBarHeight

Gets or sets the tracker bar's height. Default value is 0.08

Declaration
public double Postal4StateTrackerBarHeight { get; set; }
Property Value
Type Description
System.Double

Postal4StateTrackerBarWidth

Gets or sets the tracker bar's width. Default value is 0.0208

Declaration
public double Postal4StateTrackerBarWidth { get; set; }
Property Value
Type Description
System.Double

PostnetHeightShortBar

Gets or sets the short bars' height of Postnet symbology. Default value is 0.1

Declaration
public double PostnetHeightShortBar { get; set; }
Property Value
Type Description
System.Double

PostnetHeightTallBar

Gets or sets the tall bars' height of Postnet symbology. Default value is 0.2

Declaration
public double PostnetHeightTallBar { get; set; }
Property Value
Type Description
System.Double

PrintAsResidentElement

Gets or sets whether the barcode is printed by using the resident command. Default is false.

Declaration
public bool PrintAsResidentElement { get; set; }
Property Value
Type Description
System.Boolean
Remarks

This feature is available for ZPL printer commands only.

QRCodeByteEncodingName

Gets or sets the Encoding Name (Code Page) to be used for QR Code Byte Compaction mode. Default value is "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. Default value is Auto

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. Default value is M

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 QR Code module size. The module is each indivual black square which composes the whole of QR Code symbol. Default value is 0.0417

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. Default value is false

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. Default value is Auto

Declaration
public QRCodeVersion QRCodeVersion { get; set; }
Property Value
Type Description
QRCodeVersion

QuietZone

Gets or sets the left, top, right and bottom quiet zones. Default value is 0.1, 0, 0.1, 0.02

Declaration
public FrameThickness QuietZone { get; set; }
Property Value
Type Description
FrameThickness

RectMicroQRCodeVersion

Gets or sets the Rectangular Micro QR Code Version to use on that symbology. Default value is Auto

Declaration
public RectMicroQRCodeVersion RectMicroQRCodeVersion { get; set; }
Property Value
Type Description
RectMicroQRCodeVersion

RightToLeft

Gets or sets whether the human readable text should draw right-to-left for RTL languages. Default value is false

Declaration
public bool RightToLeft { get; set; }
Property Value
Type Description
System.Boolean

RotationAngle

Gets or sets the rotation angle, in 90 degrees increments only, to apply on this item. It is measured clockwise from the x-axis. Default value is 0 (zero)

Declaration
public int RotationAngle { get; set; }
Property Value
Type Description
System.Int32
Exceptions
Type Condition
System.ArgumentOutOfRangeException

The specified value is not in 90 degrees increments.

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 value is 4.

Declaration
public int SegmentsPerRow { get; set; }
Property Value
Type Description
System.Int32

Sizing

Gets or sets the barcode sizing. Default value is None

Declaration
public BarcodeSizing Sizing { get; set; }
Property Value
Type Description
BarcodeSizing

Symbology

Gets or sets the barcode symbology/standard to generate. Default value is Code39

Declaration
public BarcodeSymbology Symbology { get; set; }
Property Value
Type Description
BarcodeSymbology

TelepenEncoding

Gets or sets the Telepen Encoding to use on that symbology. Default value is Ascii

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. 'Product ID'. Note: This is not the value to encode. Default value is an empty string.

Declaration
public string Text { get; set; }
Property Value
Type Description
System.String

TextAlignment

Gets or sets the text alignment for Text property. Default value is AboveCenter

Declaration
public BarcodeTextAlignment TextAlignment { get; set; }
Property Value
Type Description
BarcodeTextAlignment

TextFont

Gets the Font object for the Text property. Default value is NativePrinterFontA, 10pt

Declaration
public Font TextFont { get; }
Property Value
Type Description
Font

TextForeColor

Gets or sets the foreground color of the text. Default value is Black

Declaration
public Color TextForeColor { get; set; }
Property Value
Type Description
Color

TextForeColorHex

Gets or sets the foreground color of the text in hex notation.

Declaration
public string TextForeColorHex { get; set; }
Property Value
Type Description
System.String
Remarks

The Color Hex notation is as follows #[AA]RRGGBB where A, R, G, B refers to Aplha, Red, Green and Blue pixels. The following options would also be valid: #RGB or #ARGB (in this short format all channel values must be the same), #RRGGBB or #AARRGGBB.

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

UpcESystem

Gets or sets the number system to use for UPC-E symbology. Default value is System0

Declaration
public UpcE UpcESystem { get; set; }
Property Value
Type Description
UpcE

UseQuietZoneForText

Gets or sets whether quiet zones are used for drawing Text, Code and HumanReadableText properties. Default value is false

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. Default value is A

Declaration
public FIM UspsFimPattern { get; set; }
Property Value
Type Description
FIM

UspsHorizontalBarsCount

Gets or sets the number of horizontal bars to be drawn. Default value is 10

Declaration
public int UspsHorizontalBarsCount { get; set; }
Property Value
Type Description
System.Int32

Width

Gets or sets the width of the rectangle container. Default value is 1

Declaration
public double Width { get; set; }
Property Value
Type Description
System.Double

Methods

Clone()

Creates a copy of the current BarcodeItem.

Declaration
public override Item Clone()
Returns
Type Description
Item

A copy of the current BarcodeItem.
Overrides

ConvertToUnit(UnitType)

Declaration
public override void ConvertToUnit(UnitType unit)
Parameters
Type Name Description
UnitType unit
Overrides

GetAutoSize(Double, Boolean)

Gets the size of the barcode that fits its content.

Declaration
public Tuple<double, double> GetAutoSize(double dpi = 96, bool updateLayout = false)
Parameters
Type Name Description
System.Double dpi

The output resolution in dots per inch. Default is 96.
System.Boolean updateLayout

Whether the X, Y, Width and Height properties must be updated based on the new size and the barcode aligment setting. Default is false.
Returns
Type Description
System.Tuple<System.Double, System.Double>

The size of the barcode that fits its content. Item1 refers to the Width and Item2 refers to the Height.

PrintAsResidentElementIsSupported(out String)

Validates whether the current properties settings allow the barcode to print as a resident element.

Declaration
public bool PrintAsResidentElementIsSupported(out string validationErrorMessage)
Parameters
Type Name Description
System.String validationErrorMessage
Returns
Type Description
System.Boolean

True if the barcode can be printed as a resident element; otherwise false.
Remarks

Set the ErrorBehavior property to BarcodeErrorBehavior.ThrowException to get an error description when the validation fails.

UpdateFrom(Item)

Updates this BarcodeItem object with the properties of the specified BarcodeItem object.

Declaration
public override void UpdateFrom(Item item)
Parameters
Type Name Description
Item item

The BarcodeItem object that is used for updating this BarcodeItem object.
Overrides