Class BarcodeProfessional
Neodynamic Barcode Professional allows you to quickly and easily add barcodes into any .NET CORE applications.
Inheritance
Namespace: Neodynamic.SDK.BarcodeCore
Assembly: Neodynamic.SDK.BarcodeCore.dll
Syntax
public class BarcodeProfessional : Object, ISerializable, IXmlSerializable, IDisposable, ICloneableConstructors
BarcodeProfessional()
Declaration
public BarcodeProfessional()BarcodeProfessional(SerializationInfo, StreamingContext)
Declaration
protected BarcodeProfessional(SerializationInfo info, StreamingContext context)Parameters
| Type | Name | Description |
|---|---|---|
| System.Runtime.Serialization.SerializationInfo | info | |
| System.Runtime.Serialization.StreamingContext | context |
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 generated and attached to the value to encode.
Declaration
public bool AddChecksum { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
AntiAlias
Gets or sets whether 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 |
AutoSize
Gets or sets 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.
Declaration
public SKColor BackColor { get; set; }Property Value
| Type | Description |
|---|---|
| SkiaSharp.SKColor |
BarcodePadding
Gets or sets the extra space inside the border. The unit of measure must be specified to BarcodeUnit property.
Declaration
public Margin BarcodePadding { get; set; }Property Value
| Type | Description |
|---|---|
| Margin |
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 SKColor BarColor { get; set; }Property Value
| Type | Description |
|---|---|
| SkiaSharp.SKColor |
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 called 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 called 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 border's color.
Declaration
public SKColor BorderColor { get; set; }Property Value
| Type | Description |
|---|---|
| SkiaSharp.SKColor |
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 border's width. The unit of measure must be specified to BarcodeUnit property.
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 |
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 |
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 and HumanReadableText properties.
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 |
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 EAN/UPC 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 |
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 |
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
Gest or sets the Font object for using when rendering Code and HumanReadableText properties.
Declaration
public SKTypeface Font { get; set; }Property Value
| Type | Description |
|---|---|
| SkiaSharp.SKTypeface |
FontSizeInPoints
Gets or sets the Font size in points unit (1/72 inch) when rendering Code and HumanReadableText properties. Default is 8pt.
Declaration
public float FontSizeInPoints { get; set; }Property Value
| Type | Description |
|---|---|
| System.Single |
ForeColor
Gets or sets the text color for using when rendering Code and HumanReadableText properties.
Declaration
public SKColor ForeColor { get; set; }Property Value
| Type | Description |
|---|---|
| SkiaSharp.SKColor |
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 EAN/UPC 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 height of the barcode image if AutoSize property is not enabled. 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 |
Isbt128DataStructure
Gets or sets the ISBT 128 Data Structure to be generated.
Declaration
public Isbt128DataStructure Isbt128DataStructure { get; set; }Property Value
| Type | Description |
|---|---|
| Isbt128DataStructure |
IsCodeValid
Gets a value indicating whether the value to encode specified in the Code property is valid based on the Barcode Symbology specified in the Symbology property.
Declaration
public bool IsCodeValid { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
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 |
LicenseKey
Gets or sets the License Key.
Declaration
public static string LicenseKey { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
LicenseOwner
Gets or sets the License Owner.
Declaration
public static 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 |
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 |
MsiChecksum
Gets or sets the checksum mode to be used on MSI symbology.
Declaration
public MsiChecksum MsiChecksum { get; set; }Property Value
| Type | Description |
|---|---|
| MsiChecksum |
OutputSettings
Gets a list of settings that were used to generate the selected symbology.
Declaration
public Hashtable OutputSettings { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Hashtable |
Remarks
Some barcode symbologies have properties with an Auto option which means that the algorithm should select it at runtime based on some parameters.
This list will contain the Property Name as the 'Key' and its runtime value as the 'Value'. E.g. if a QR Code was generated and QRCodeVersion property was set to Auto, then this list will containg an entry which 'Key' is "QRCodeVersion" and its value could be "V10" (for Version 10)
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 |
PharmacodeBarsSpacing
Gets or sets the gap between Pharmacode bars. The unit of measure must be specified to BarcodeUnit property.
Declaration
public double PharmacodeBarsSpacing { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double |
PharmacodeThickBarWidth
Gets or sets the width of Pharmacode Thick Bars. The unit of measure must be specified to BarcodeUnit property.
Declaration
public double PharmacodeThickBarWidth { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double |
PharmacodeThinBarWidth
Gets or sets the width of Pharmacode Thin Bars. The unit of measure must be specified to BarcodeUnit property.
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 |
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 |
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.: Product ID. Note: This is not the value to encode nor the Human Readable Text.
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 |
TextFont
Gest or sets the Font object for using when rendering Text property.
Declaration
public SKTypeface TextFont { get; set; }Property Value
| Type | Description |
|---|---|
| SkiaSharp.SKTypeface |
TextFontSizeInPoints
Gets or sets the Font size in points unit (1/72 inch) when rendering Text property. Default is 8pt.
Declaration
public float TextFontSizeInPoints { get; set; }Property Value
| Type | Description |
|---|---|
| System.Single |
TextForeColor
Gets or sets the text color for using when rendering Text property.
Declaration
public SKColor TextForeColor { get; set; }Property Value
| Type | Description |
|---|---|
| SkiaSharp.SKColor |
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 |
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 |
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, Code and HumanReadableText 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 width of the barcode image if AutoSize property is not enabled. The unit of measure must be specified to BarcodeUnit property.
Declaration
public double Width { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double |
Methods
Clone()
Declaration
public object Clone()Returns
| Type | Description |
|---|---|
| System.Object |
Dispose()
Declaration
public void Dispose()DrawOnCanvas(SKCanvas)
Draws the barcode onto the graphics object at the origin point.
Declaration
public void DrawOnCanvas(SKCanvas canvas)Parameters
| Type | Name | Description |
|---|---|---|
| SkiaSharp.SKCanvas | canvas | The SKCanvas object to draw with. |
DrawOnCanvas(SKCanvas, SKPoint)
Draws the barcode onto the graphics object at the given point.
Declaration
public void DrawOnCanvas(SKCanvas canvas, SKPoint pt)Parameters
| Type | Name | Description |
|---|---|---|
| SkiaSharp.SKCanvas | canvas | The SKCanvas object to draw with. The unit of measure must be specified to BarcodeUnit property. |
| SkiaSharp.SKPoint | pt | The point on the canvas object to begin drawing the barcode. |
GetBarcodeImage()
Gets a SKBitmap object of the barcode image in PNG format.
Declaration
public SKBitmap GetBarcodeImage()Returns
| Type | Description |
|---|---|
| SkiaSharp.SKBitmap | A SKBitmap object that represent the barcode image in PNG format. |
GetBarcodeImage(SKEncodedImageFormat)
Gets a byte array that represents the barcode image in the specified format.
Declaration
public byte[] GetBarcodeImage(SKEncodedImageFormat imageFormat)Parameters
| Type | Name | Description |
|---|---|---|
| SkiaSharp.SKEncodedImageFormat | imageFormat | The SKEncodedImageFormat value for the barcode image. |
Returns
| Type | Description |
|---|---|
| System.Byte[] | A byte array representation of the barcode image. |
GetBarcodeImage(SKEncodedImageFormat, Single)
Gets a byte array that represents the barcode image in the specified format and DPI values.
Declaration
public byte[] GetBarcodeImage(SKEncodedImageFormat imageFormat, float dpi)Parameters
| Type | Name | Description |
|---|---|---|
| SkiaSharp.SKEncodedImageFormat | imageFormat | The SKEncodedImageFormat value for the barcode image. |
| System.Single | dpi | The DPI resolution for the barcode image. NOTE: Only JPEG format supports this setting. |
Returns
| Type | Description |
|---|---|
| System.Byte[] | A byte array representation of the barcode image. |
GetBarcodeImage(Single)
Gets a SKBitmap object of the barcode image in PNG format at the specified scale factor.
Declaration
public SKBitmap GetBarcodeImage(float scale)Parameters
| Type | Name | Description |
|---|---|---|
| System.Single | scale | The scale factor. Value 1 means 100% |
Returns
| Type | Description |
|---|---|
| SkiaSharp.SKBitmap | A SKBitmap object of the barcode image in PNG format at the specified scale factor. |
GetBarcodeImageSvg()
Gets a byte array that represents the barcode image in SVG format.
Declaration
public byte[] GetBarcodeImageSvg()Returns
| Type | Description |
|---|---|
| System.Byte[] | A byte array representation of the barcode image in SVG format. |
GetObjectData(SerializationInfo, StreamingContext)
Declaration
public virtual void GetObjectData(SerializationInfo info, StreamingContext context)Parameters
| Type | Name | Description |
|---|---|---|
| System.Runtime.Serialization.SerializationInfo | info | |
| System.Runtime.Serialization.StreamingContext | context |
GetSchema()
Declaration
public XmlSchema GetSchema()Returns
| Type | Description |
|---|---|
| System.Xml.Schema.XmlSchema |
ReadXml(XmlReader)
Declaration
public void ReadXml(XmlReader reader)Parameters
| Type | Name | Description |
|---|---|---|
| System.Xml.XmlReader | reader |
Save(String, SKEncodedImageFormat)
Saves this barcode image to the specified file in the specified format.
Declaration
public void Save(string filename, SKEncodedImageFormat format)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | filename | A string that contains the name of the file to which to save this barcode image. |
| SkiaSharp.SKEncodedImageFormat | format | The SKEncodedImageFormat object for this barcode image. |
Save(String, SKEncodedImageFormat, Single)
Saves this barcode image to the specified file in the specified format and resolution.
Declaration
public void Save(string filename, SKEncodedImageFormat format, float dpi)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | filename | A string that contains the name of the file to which to save this barcode image. |
| SkiaSharp.SKEncodedImageFormat | format | The SKEncodedImageFormat object for this barcode image. |
| System.Single | dpi | The resolution, in dots per inch, of the barcode image. NOTE: Only JPEG format supports this setting. |
WriteXml(XmlWriter)
Declaration
public void WriteXml(XmlWriter writer)Parameters
| Type | Name | Description |
|---|---|---|
| System.Xml.XmlWriter | writer |