Class BarcodeProfessional

Neodynamic Barcode Professional allows you to quickly and easily add barcodes images into your ASP.NET Web applications including full design time development support.

Inheritance
System.Object
System.Web.UI.Control
System.Web.UI.WebControls.WebControl
BarcodeProfessional
Inherited Members
System.Web.UI.WebControls.WebControl.AddAttributesToRender(System.Web.UI.HtmlTextWriter)
System.Web.UI.WebControls.WebControl.ApplyStyle(System.Web.UI.WebControls.Style)
System.Web.UI.WebControls.WebControl.CopyBaseAttributes(System.Web.UI.WebControls.WebControl)
System.Web.UI.WebControls.WebControl.CreateControlStyle()
System.Web.UI.WebControls.WebControl.MergeStyle(System.Web.UI.WebControls.Style)
System.Web.UI.WebControls.WebControl.RenderBeginTag(System.Web.UI.HtmlTextWriter)
System.Web.UI.WebControls.WebControl.RenderEndTag(System.Web.UI.HtmlTextWriter)
System.Web.UI.WebControls.WebControl.RenderContents(System.Web.UI.HtmlTextWriter)
System.Web.UI.WebControls.WebControl.System.Web.UI.IAttributeAccessor.GetAttribute(System.String)
System.Web.UI.WebControls.WebControl.System.Web.UI.IAttributeAccessor.SetAttribute(System.String, System.String)
System.Web.UI.WebControls.WebControl.AccessKey
System.Web.UI.WebControls.WebControl.Attributes
System.Web.UI.WebControls.WebControl.BackColor
System.Web.UI.WebControls.WebControl.BorderColor
System.Web.UI.WebControls.WebControl.BorderStyle
System.Web.UI.WebControls.WebControl.ControlStyle
System.Web.UI.WebControls.WebControl.ControlStyleCreated
System.Web.UI.WebControls.WebControl.CssClass
System.Web.UI.WebControls.WebControl.Style
System.Web.UI.WebControls.WebControl.Enabled
System.Web.UI.WebControls.WebControl.EnableTheming
System.Web.UI.WebControls.WebControl.Font
System.Web.UI.WebControls.WebControl.ForeColor
System.Web.UI.WebControls.WebControl.HasAttributes
System.Web.UI.WebControls.WebControl.IsEnabled
System.Web.UI.WebControls.WebControl.SkinID
System.Web.UI.WebControls.WebControl.TabIndex
System.Web.UI.WebControls.WebControl.TagKey
System.Web.UI.WebControls.WebControl.TagName
System.Web.UI.WebControls.WebControl.ToolTip
System.Web.UI.Control.ResolveAdapter()
System.Web.UI.Control.HasEvents()
System.Web.UI.Control.ApplyStyleSheetSkin(System.Web.UI.Page)
System.Web.UI.Control.OnDataBinding(System.EventArgs)
System.Web.UI.Control.DataBind()
System.Web.UI.Control.DataBind(System.Boolean)
System.Web.UI.Control.DataBindChildren()
System.Web.UI.Control.AddParsedSubObject(System.Object)
System.Web.UI.Control.EnsureID()
System.Web.UI.Control.ClearChildState()
System.Web.UI.Control.ClearChildControlState()
System.Web.UI.Control.ClearChildViewState()
System.Web.UI.Control.Focus()
System.Web.UI.Control.LoadControlState(System.Object)
System.Web.UI.Control.MapPathSecure(System.String)
System.Web.UI.Control.OpenFile(System.String)
System.Web.UI.Control.OnLoad(System.EventArgs)
System.Web.UI.Control.OnPreRender(System.EventArgs)
System.Web.UI.Control.BuildProfileTree(System.String, System.Boolean)
System.Web.UI.Control.SaveControlState()
System.Web.UI.Control.RenderChildren(System.Web.UI.HtmlTextWriter)
System.Web.UI.Control.RenderControl(System.Web.UI.HtmlTextWriter)
System.Web.UI.Control.RenderControl(System.Web.UI.HtmlTextWriter, System.Web.UI.Adapters.ControlAdapter)
System.Web.UI.Control.OnUnload(System.EventArgs)
System.Web.UI.Control.Dispose()
System.Web.UI.Control.RaiseBubbleEvent(System.Object, System.EventArgs)
System.Web.UI.Control.OnBubbleEvent(System.Object, System.EventArgs)
System.Web.UI.Control.AddedControl(System.Web.UI.Control, System.Int32)
System.Web.UI.Control.CreateChildControls()
System.Web.UI.Control.ResolveUrl(System.String)
System.Web.UI.Control.ResolveClientUrl(System.String)
System.Web.UI.Control.FindControl(System.String)
System.Web.UI.Control.FindControl(System.String, System.Int32)
System.Web.UI.Control.GetDesignModeState()
System.Web.UI.Control.HasControls()
System.Web.UI.Control.IsLiteralContent()
System.Web.UI.Control.EnsureChildControls()
System.Web.UI.Control.RemovedControl(System.Web.UI.Control)
System.Web.UI.Control.SetDesignModeState(System.Collections.IDictionary)
System.Web.UI.Control.SetRenderMethodDelegate(System.Web.UI.RenderMethod)
System.Web.UI.Control.System.Web.UI.IParserAccessor.AddParsedSubObject(System.Object)
System.Web.UI.Control.System.Web.UI.IControlDesignerAccessor.GetDesignModeState()
System.Web.UI.Control.System.Web.UI.IControlDesignerAccessor.SetDesignModeState(System.Collections.IDictionary)
System.Web.UI.Control.System.Web.UI.IControlDesignerAccessor.SetOwnerControl(System.Web.UI.Control)
System.Web.UI.Control.ClientID
System.Web.UI.Control.ClientIDSeparator
System.Web.UI.Control.Context
System.Web.UI.Control.Adapter
System.Web.UI.Control.DesignMode
System.Web.UI.Control.Events
System.Web.UI.Control.ID
System.Web.UI.Control.IsChildControlStateCleared
System.Web.UI.Control.EnableViewState
System.Web.UI.Control.IsViewStateEnabled
System.Web.UI.Control.NamingContainer
System.Web.UI.Control.IdSeparator
System.Web.UI.Control.LoadViewStateByID
System.Web.UI.Control.Page
System.Web.UI.Control.TemplateControl
System.Web.UI.Control.Parent
System.Web.UI.Control.TemplateSourceDirectory
System.Web.UI.Control.AppRelativeTemplateSourceDirectory
System.Web.UI.Control.Site
System.Web.UI.Control.Visible
System.Web.UI.Control.UniqueID
System.Web.UI.Control.HasChildViewState
System.Web.UI.Control.Controls
System.Web.UI.Control.ViewState
System.Web.UI.Control.ViewStateIgnoresCase
System.Web.UI.Control.ChildControlsCreated
System.Web.UI.Control.IsTrackingViewState
System.Web.UI.Control.System.Web.UI.IDataBindingsAccessor.HasDataBindings
System.Web.UI.Control.System.Web.UI.IDataBindingsAccessor.DataBindings
System.Web.UI.Control.System.Web.UI.IControlDesignerAccessor.UserData
System.Web.UI.Control.System.Web.UI.IControlBuilderAccessor.ControlBuilder
System.Web.UI.Control.System.Web.UI.IExpressionsAccessor.HasExpressions
System.Web.UI.Control.System.Web.UI.IExpressionsAccessor.Expressions
System.Web.UI.Control.Disposed
System.Web.UI.Control.DataBinding
System.Web.UI.Control.Init
System.Web.UI.Control.Load
System.Web.UI.Control.PreRender
System.Web.UI.Control.Unload
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.WebControls.BarcodeProfessional
Assembly: Neodynamic.WebControls.BarcodeProfessional.dll
Syntax
public class BarcodeProfessional : WebControl, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IHttpHandler, ICloneable

Constructors

BarcodeProfessional()

Declaration
public BarcodeProfessional()

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

AlternateText

Declaration
[Bindable(true)]
public string AlternateText { get; set; }
Property Value
Type Description
System.String

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

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. Note: this feature is not available when exporting the barcode symbol to EPS format.

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

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. Note: this feature is not available when exporting the barcode symbol to EPS format.

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
[TypeConverter(typeof (LogoPosition))]
public LogoPosition ArtLogoImagePosition { get; set; }
Property Value
Type Description
LogoPosition

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
[TypeConverter(typeof (AztecCodeFormat))]
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

BarcodeUnit

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

Declaration
[TypeConverter(typeof (BarcodeUnit))]
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
[TypeConverter(typeof (BearerBarStyle))]
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

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

Declaration
public override Unit BorderWidth { get; set; }
Property Value
Type Description
System.Web.UI.WebControls.Unit
Overrides
System.Web.UI.WebControls.WebControl.BorderWidth

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

BottomPadding

Gets or sets the extra space inside the bottom border. The unit of measure must be specified to BarcodeUnit property.

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

CacheExpiresAtDateTime

Gets or sets the time at which the output image expires and is removed from the server cache.

Declaration
public DateTime CacheExpiresAtDateTime { get; set; }
Property Value
Type Description
System.DateTime

CacheExpiresInSeconds

Gets or sets the number of seconds that the server can cache the output image.

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

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
[TypeConverter(typeof (CodabarStartStopChar))]
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
[TypeConverter(typeof (CodabarStartStopChar))]
public CodabarStartStopChar CodabarStopChar { get; set; }
Property Value
Type Description
CodabarStartStopChar

Code

Gets or sets the value to encode.

Declaration
[Bindable(true)]
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
[TypeConverter(typeof (Code128))]
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
[TypeConverter(typeof (Code16k))]
public Code16k Code16kMode { get; set; }
Property Value
Type Description
Code16k

CodeAlignment

Gets or sets the text alignment for Code property.

Declaration
[TypeConverter(typeof (Alignment))]
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 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
[TypeConverter(typeof (DataMatrixEncoding))]
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
[TypeConverter(typeof (DataMatrixFormat))]
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
[TypeConverter(typeof (DotCodeModuleShape))]
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
[TypeConverter(typeof (Supplement))]
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

EmbedAsBase64Image

Gets or sets whether the barcode image is embedded into the page as a Base64 image. Default is false.

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

ErrorBehavior

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

Declaration
[TypeConverter(typeof (ErrorBehavior))]
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

FitBarsAreaToSize

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

Declaration
public SizeF FitBarsAreaToSize { get; set; }
Property Value
Type Description
System.Drawing.SizeF

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

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
[TypeConverter(typeof (HanXinCodeEncoding))]
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
[TypeConverter(typeof (HanXinCodeErrorCorrectionLevel))]
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
[TypeConverter(typeof (HanXinCodeVersion))]
public HanXinCodeVersion HanXinCodeVersion { get; set; }
Property Value
Type Description
HanXinCodeVersion

Height

Declaration
public override Unit Height { get; set; }
Property Value
Type Description
System.Web.UI.WebControls.Unit
Overrides
System.Web.UI.WebControls.WebControl.Height

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

HighQualityGif

Gets or sets whether imaging quantification process must be applied in order to obtain high quality barcodes in GIF format.

Declaration
public bool HighQualityGif { 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
[Bindable(true)]
public string HumanReadableText { get; set; }
Property Value
Type Description
System.String

ImageFormat

Gets or sets the barcode image format to render.

Declaration
[TypeConverter(typeof (BarcodeImageFormat))]
public BarcodeImageFormat ImageFormat { get; set; }
Property Value
Type Description
BarcodeImageFormat

Isbt128DataStructure

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

Declaration
[TypeConverter(typeof (Isbt128DataStructure))]
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
[Browsable(false)]
public bool IsCodeValid { get; }
Property Value
Type Description
System.Boolean

IsReusable

Declaration
[Browsable(false)]
public bool IsReusable { get; }
Property Value
Type Description
System.Boolean
Implements
System.Web.IHttpHandler.IsReusable

Itf14LeftHMark

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

Declaration
[TypeConverter(typeof (ItfHmark))]
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
[TypeConverter(typeof (ItfHmark))]
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.

LeftPadding

Gets or sets the extra space inside the left border. The unit of measure must be specified to BarcodeUnit property.

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

LicenseKey

Gets or sets the License Key.

Declaration
[Browsable(false)]
public static string LicenseKey { get; set; }
Property Value
Type Description
System.String

LicenseOwner

Gets or sets the License Owner.

Declaration
[Browsable(false)]
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
[TypeConverter(typeof (MaxiCodeModes))]
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
[TypeConverter(typeof (MicroPdf417Version))]
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
[TypeConverter(typeof (MicroQRCodeVersion))]
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
[TypeConverter(typeof (MsiChecksum))]
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
[TypeConverter(typeof (Pdf417CompactionType))]
public Pdf417CompactionType Pdf417CompactionType { get; set; }
Property Value
Type Description
Pdf417CompactionType

Pdf417ErrorCorrectionLevel

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

Declaration
[TypeConverter(typeof (Pdf417ErrorCorrection))]
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
[TypeConverter(typeof (Pharmacode2DColorFields))]
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
[TypeConverter(typeof (Pharmacode2DTriggerMark))]
public Pharmacode2DTriggerMark Pharmacode2DTriggerMark { get; set; }
Property Value
Type Description
Pharmacode2DTriggerMark

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
[TypeConverter(typeof (QRCodeEncoding))]
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
[TypeConverter(typeof (QRCodeErrorCorrectionLevel))]
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
[TypeConverter(typeof (QRCodeVersion))]
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
[TypeConverter(typeof (RectMicroQRCodeVersion))]
public RectMicroQRCodeVersion RectMicroQRCodeVersion { get; set; }
Property Value
Type Description
RectMicroQRCodeVersion

RenderingMethod

Gets or sets the barcode rendering mechanism to be used. To enhance performance in the barcode generation set this property to HttpHandler. IMPORTANT: if this property is set to HttpHandler you must add the following entry in the Web.Config file under system.web node:

Declaration
[TypeConverter(typeof (RenderingMethod))]
public RenderingMethod RenderingMethod { get; set; }
Property Value
Type Description
RenderingMethod

RightPadding

Gets or sets the extra space inside the right border. The unit of measure must be specified to BarcodeUnit property.

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

Rotate

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

Declaration
[TypeConverter(typeof (Rotate))]
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
[TypeConverter(typeof (Symbology))]
public Symbology Symbology { get; set; }
Property Value
Type Description
Symbology

TelepenEncoding

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

Declaration
[TypeConverter(typeof (TelepenEncoding))]
public TelepenEncoding TelepenEncoding { get; set; }
Property Value
Type Description
TelepenEncoding

TemporaryStorage

Gets or sets the temporary storage for the barcode content when rendering the src attribute of the HTML Image Tag representing the barcode image.

Declaration
[TypeConverter(typeof (TemporaryStorage))]
public TemporaryStorage TemporaryStorage { get; set; }
Property Value
Type Description
TemporaryStorage

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
[Bindable(true)]
public string Text { get; set; }
Property Value
Type Description
System.String

TextAlignment

Gets or sets the text alignment for Text property.

Declaration
[TypeConverter(typeof (Alignment))]
public Alignment TextAlignment { get; set; }
Property Value
Type Description
Alignment

TextFont

Gets the FontInfo object for using when rendering Text property.

Declaration
[Bindable(true)]
public FontInfo TextFont { get; }
Property Value
Type Description
System.Web.UI.WebControls.FontInfo

TextForeColor

Gets or sets the text color for using when rendering Text property.

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

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

TiffCompression

Gets or sets the TIFF compression algorithm to be used when saving barcodes in such image format.

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

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

TopPadding

Gets or sets the extra space inside the top border. The unit of measure must be specified to BarcodeUnit property.

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

UpcESystem

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

Declaration
[TypeConverter(typeof (UpcE))]
public UpcE UpcESystem { get; set; }
Property Value
Type Description
UpcE

UseAbsoluteUrl

Gets or sets whether absolute full URL must be used when rendering the source attribute of the barcode image tag.

Declaration
[Bindable(true)]
public bool UseAbsoluteUrl { get; set; }
Property Value
Type Description
System.Boolean

UseCache

Gets or sets whether the barcode image should be stored in the ASP.NET Output Cache.

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

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
[TypeConverter(typeof (FIM))]
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

Declaration
public override Unit Width { get; set; }
Property Value
Type Description
System.Web.UI.WebControls.Unit
Overrides
System.Web.UI.WebControls.WebControl.Width

Methods

Clone()

Declaration
public object Clone()
Returns
Type Description
System.Object
Implements
System.ICloneable.Clone()

CreateControlCollection()

Declaration
protected override ControlCollection CreateControlCollection()
Returns
Type Description
System.Web.UI.ControlCollection
Overrides
System.Web.UI.Control.CreateControlCollection()

DrawOnCanvas(Graphics)

Draws the barcode onto the graphics object at the origin point.

Declaration
public void DrawOnCanvas(Graphics graphic)
Parameters
Type Name Description
System.Drawing.Graphics graphic

The Graphics object to draw with.

DrawOnCanvas(Graphics, PointF)

Draws the barcode onto the graphics object at the given point.

Declaration
public void DrawOnCanvas(Graphics graphic, PointF pt)
Parameters
Type Name Description
System.Drawing.Graphics graphic

The Graphics object to draw with. The unit of measure must be specified to BarcodeUnit property.
System.Drawing.PointF pt

The point on the graphic object to begin drawing the barcode.

DrawOnCanvas(Graphics, PointF, SizeF)

Draws the barcode onto the specified graphics object fitting the bars into the specified size.

Declaration
public void DrawOnCanvas(Graphics graphic, PointF pt, SizeF barsAreaSize)
Parameters
Type Name Description
System.Drawing.Graphics graphic

The Graphics object to draw with.
System.Drawing.PointF pt

The point on the graphic object to begin drawing the barcode. The unit of measure must be specified to BarcodeUnit property.
System.Drawing.SizeF barsAreaSize

The desired bars area size that the barcode must fit in. The unit of measure must be specified to BarcodeUnit property.

DrawOnCanvas(Graphics, PointF, SizeF, Single)

Draws the barcode onto the graphics object at the given point and in the specified scale.

Declaration
public void DrawOnCanvas(Graphics graphic, PointF pt, SizeF barsAreaSize, float scale)
Parameters
Type Name Description
System.Drawing.Graphics graphic

The Graphics object to draw with. The unit of measure must be specified to BarcodeUnit property.
System.Drawing.PointF pt

The point on the graphic object to begin drawing the barcode.
System.Drawing.SizeF barsAreaSize

The desired bars area size that the barcode must fit in. The unit of measure must be specified to BarcodeUnit property.
System.Single scale

The value to scale the barcode.

DrawOnCanvas(Graphics, PointF, Single)

Draws the barcode onto the graphics object at the given point and in the specified scale.

Declaration
public void DrawOnCanvas(Graphics graphic, PointF pt, float scale)
Parameters
Type Name Description
System.Drawing.Graphics graphic

The Graphics object to draw with. The unit of measure must be specified to BarcodeUnit property.
System.Drawing.PointF pt

The point on the graphic object to begin drawing the barcode.
System.Single scale

The value to scale the barcode.

GetBarcodeImage()

Gets a System.Drawing.Image object of the barcode image.

Declaration
public Bitmap GetBarcodeImage()
Returns
Type Description
System.Drawing.Bitmap

A System.Drawing.Bitmap object that represent the barcode image.

GetBarcodeImage(ImageFormat)

Gets a byte array that represents the barcode image.

Declaration
public byte[] GetBarcodeImage(ImageFormat imageFormat)
Parameters
Type Name Description
System.Drawing.Imaging.ImageFormat imageFormat

The ImageFormat object for the barcode image.
Returns
Type Description
System.Byte[]

A byte array representation of the barcode image.

GetBarcodeImage(ImageFormat, Single)

Gets a byte array that represents the barcode image at the specified resolution.

Declaration
public byte[] GetBarcodeImage(ImageFormat imageFormat, float dpi)
Parameters
Type Name Description
System.Drawing.Imaging.ImageFormat imageFormat

The ImageFormat object for the barcode image.
System.Single dpi

The resolution, in dots per inch, of the output image.
Returns
Type Description
System.Byte[]

A byte array representation of the barcode image at the specified resolution.

GetBarcodeImage(ImageFormat, Single, SizeF)

Gets a byte array that represents the barcode image fitting the bars into the specified size.

Declaration
public byte[] GetBarcodeImage(ImageFormat imageFormat, float dpi, SizeF barsAreaSize)
Parameters
Type Name Description
System.Drawing.Imaging.ImageFormat imageFormat

The ImageFormat object for the barcode image.
System.Single dpi

The resolution, in dots per inch, of the output image.
System.Drawing.SizeF barsAreaSize

The desired bars area size that the barcode must fit in. The unit of measure must be specified to BarcodeUnit property.
Returns
Type Description
System.Byte[]

A byte array representation of the barcode image.

GetBarcodeImage(ImageFormat, Single, Single)

Gets a byte array that represents the barcode image at the specified horizontal and vertical resolutions.

Declaration
public byte[] GetBarcodeImage(ImageFormat imageFormat, float xDpi, float yDpi)
Parameters
Type Name Description
System.Drawing.Imaging.ImageFormat imageFormat

The ImageFormat object for the barcode image.
System.Single xDpi

The horizontal resolution, in dots per inch, of the output image.
System.Single yDpi

The vertical resolution, in dots per inch, of the output image.
Returns
Type Description
System.Byte[]

A byte array representation of the barcode image at the specified horizontal and vertical resolutions.

GetBarcodeImage(ImageFormat, Single, Single, SizeF)

Gets a byte array that represents the barcode image fitting the bars into the specified size and resolutions.

Declaration
public byte[] GetBarcodeImage(ImageFormat imageFormat, float xDpi, float yDpi, SizeF barsAreaSize)
Parameters
Type Name Description
System.Drawing.Imaging.ImageFormat imageFormat

The ImageFormat object for the barcode image.
System.Single xDpi

The horizontal resolution, in dots per inch, of the output image.
System.Single yDpi

The vertical resolution, in dots per inch, of the output image.
System.Drawing.SizeF barsAreaSize

The desired bars area size that the barcode must fit in. The unit of measure must be specified to BarcodeUnit property.
Returns
Type Description
System.Byte[]

A byte array representation of the barcode image.

GetBarcodeImage(Single)

Gets a System.Drawing.Bitmap object of the barcode image at the specified resolution.

Declaration
public Bitmap GetBarcodeImage(float dpi)
Parameters
Type Name Description
System.Single dpi

The resolution, in dots per inch, of the output image.
Returns
Type Description
System.Drawing.Bitmap

A System.Drawing.Bitmap object that represent the barcode image at the specified resolution.

GetBarcodeImage(Single, SizeF)

Gets a System.Drawing.Image object of the barcode image fitting the bars into the specified size.

Declaration
public Bitmap GetBarcodeImage(float dpi, SizeF barsAreaSize)
Parameters
Type Name Description
System.Single dpi

The resolution, in dots per inch, of the output image.
System.Drawing.SizeF barsAreaSize

The desired bars area size that the barcode must fit in. The unit of measure must be specified to BarcodeUnit property.
Returns
Type Description
System.Drawing.Bitmap

A System.Drawing.Image object that represent the barcode image.

GetBarcodeImage(Single, Single)

Gets a System.Drawing.Bitmap object of the barcode image at the specified horizontal and vertical resolutions.

Declaration
public Bitmap GetBarcodeImage(float xDpi, float yDpi)
Parameters
Type Name Description
System.Single xDpi

The horizontal resolution, in dots per inch, of the output image.
System.Single yDpi

The vertical resolution, in dots per inch, of the output image.
Returns
Type Description
System.Drawing.Bitmap

A System.Drawing.Bitmap object that represent the barcode image at the specified horizontal and vertical resolutions.

GetBarcodeImage(Single, Single, SizeF)

Gets a System.Drawing.Bitmap object of the barcode image fitting the bars into the specified size and resolutions.

Declaration
public Bitmap GetBarcodeImage(float xDpi, float yDpi, SizeF barsAreaSize)
Parameters
Type Name Description
System.Single xDpi

The horizontal resolution, in dots per inch, of the output image.
System.Single yDpi

The vertical resolution, in dots per inch, of the output image.
System.Drawing.SizeF barsAreaSize

The desired bars area size that the barcode must fit in. The unit of measure must be specified to BarcodeUnit property.
Returns
Type Description
System.Drawing.Bitmap

A System.Drawing.Bitmap object that represent the barcode image.

GetBarcodeImage(String)

Gets a byte array that represents the barcode image based on the specified MIME image format.

Declaration
public byte[] GetBarcodeImage(string MIME)
Parameters
Type Name Description
System.String MIME

The MIME image format for the barcode image.
Returns
Type Description
System.Byte[]

A byte array representation of the barcode image.

GetBarcodeUrl()

It returns a URL string used to generate the barcode image on the server side.

Declaration
public string GetBarcodeUrl()
Returns
Type Description
System.String

A string representing the URL used to generate the barcode image on the server side.

GetBarcodeUrlParam()

It returns a parameters string used to generate the barcode image on the server side.

Declaration
public string GetBarcodeUrlParam()
Returns
Type Description
System.String

A string representing the URL's parameters used to generate the barcode image on the server side.

LoadViewState(Object)

Declaration
protected override void LoadViewState(object savedState)
Parameters
Type Name Description
System.Object savedState
Overrides
System.Web.UI.WebControls.WebControl.LoadViewState(System.Object)

OnInit(EventArgs)

Declaration
protected override void OnInit(EventArgs e)
Parameters
Type Name Description
System.EventArgs e
Overrides
System.Web.UI.Control.OnInit(System.EventArgs)

ProcessBarcodeRequest()

This method makes the necessary processing to serve barcode images when a Barcode Professional object is dynamically created in a webform. It should be called in the Page’s Load event on the webform that will contain the Barcode Professional control.

Declaration
public static void ProcessBarcodeRequest()

ProcessBarcodeRequest(HttpContext)

This method makes the necessary processing to serve barcode images when a Barcode Professional object is dynamically created in a webform. It should be called in the Page’s Load event on the webform that will contain the Barcode Professional control.

Declaration
public static void ProcessBarcodeRequest(HttpContext context)
Parameters
Type Name Description
System.Web.HttpContext context

The HTTP Context object from where the barcode request will be served.

ProcessBarcodeRequest(Page)

This method makes the necessary processing to serve barcode images when a Barcode Professional object is dynamically created in a webform. It should be called in the Page’s Load event on the webform that will contain the Barcode Professional control.

Declaration
public static void ProcessBarcodeRequest(Page page)
Parameters
Type Name Description
System.Web.UI.Page page

The Page object from where the barcode request will be served.

ProcessReport(Page)

This method makes the necessary processing to serve barcode images used in a Crystal Reports report. It should be called in the Page's Load event on the webform that contains a Crystal Reports viewer.

Declaration
public static void ProcessReport(Page page)
Parameters
Type Name Description
System.Web.UI.Page page

The Page object that represents the webform that contains a Crystal Reports viewer.

ProcessReport(Page, RenderingMethod)

This method makes the necessary processing to serve barcode images used in a Crystal Reports report. It should be called in the Page's Load event on the webform that contains a Crystal Reports viewer.

Declaration
public static void ProcessReport(Page page, RenderingMethod renderingMethod)
Parameters
Type Name Description
System.Web.UI.Page page

The Page object that represents the webform that contains a Crystal Reports viewer.
RenderingMethod renderingMethod

The rendering method to use.

ProcessRequest(HttpContext)

Declaration
public void ProcessRequest(HttpContext context)
Parameters
Type Name Description
System.Web.HttpContext context
Implements
System.Web.IHttpHandler.ProcessRequest(System.Web.HttpContext)

Render(HtmlTextWriter)

Declaration
protected override void Render(HtmlTextWriter writer)
Parameters
Type Name Description
System.Web.UI.HtmlTextWriter writer
Overrides
System.Web.UI.WebControls.WebControl.Render(System.Web.UI.HtmlTextWriter)

RenderDesignTime(HtmlTextWriter)

Declaration
protected void RenderDesignTime(HtmlTextWriter writer)
Parameters
Type Name Description
System.Web.UI.HtmlTextWriter writer

Save(Stream, ImageFormat)

Saves this barcode image to the specified Stream object in the specified format.

Declaration
public void Save(Stream stream, ImageFormat format)
Parameters
Type Name Description
System.IO.Stream stream

The Stream object to which to save this barcode image.

System.Drawing.Imaging.ImageFormat format

The ImageFormat object for this barcode image.

Save(Stream, ImageFormat, Single, Single)

Saves this barcode image to the specified Stream object in the specified format and resolution.

Declaration
public void Save(Stream stream, ImageFormat format, float xDpi, float yDpi)
Parameters
Type Name Description
System.IO.Stream stream

The Stream object to which to save this barcode image.

System.Drawing.Imaging.ImageFormat format

The ImageFormat object for this barcode image.
System.Single xDpi

The horizontal resolution, in dots per inch, of the barcode image.

System.Single yDpi

The vertical resolution, in dots per inch, of the barcode image.

Save(String, ImageFormat)

Saves this barcode image to the specified file in the specified format.

Declaration
public void Save(string filename, ImageFormat format)
Parameters
Type Name Description
System.String filename

A string that contains the name of the file to which to save this barcode image.
System.Drawing.Imaging.ImageFormat format

The ImageFormat object for this barcode image.

Save(String, ImageFormat, Single, Single)

Saves this barcode image to the specified file in the specified format and resolution.

Declaration
public void Save(string filename, ImageFormat format, float xDpi, float yDpi)
Parameters
Type Name Description
System.String filename

A string that contains the name of the file to which to save this barcode image.
System.Drawing.Imaging.ImageFormat format

The ImageFormat object for this barcode image.
System.Single xDpi

The horizontal resolution, in dots per inch, of the barcode image.

System.Single yDpi

The vertical resolution, in dots per inch, of the barcode image.

SaveEpsImage(Stream, Encoding)

Saves this barcode to the specified Stream object and text encoding in EPS (Encapsulated PostScript) format.

Declaration
public void SaveEpsImage(Stream stream, Encoding encoding)
Parameters
Type Name Description
System.IO.Stream stream

The Stream object to which to save this barcode.

System.Text.Encoding encoding

The Encoding object used for writing the stream object.

SaveEpsImage(Stream, Encoding, EpsCmykBarcodeColors)

Saves this barcode to the specified Stream object and text encoding in EPS (Encapsulated PostScript) format with CMYK color space.

Declaration
public void SaveEpsImage(Stream stream, Encoding encoding, EpsCmykBarcodeColors cmykBarcodeColors)
Parameters
Type Name Description
System.IO.Stream stream

The Stream object to which to save this barcode.

System.Text.Encoding encoding

The Encoding object used for writing the stream object.
EpsCmykBarcodeColors cmykBarcodeColors

The CMYK colors for each part of the barcode.

SaveEpsImage(String, Encoding)

Saves this barcode to the specified file in EPS (Encapsulated PostScript) format.

Declaration
public void SaveEpsImage(string filename, Encoding encoding)
Parameters
Type Name Description
System.String filename

A string that contains the name of the file to which to save this barcode.
System.Text.Encoding encoding

The Encoding object used for writing the file stream object.

SaveEpsImage(String, Encoding, EpsCmykBarcodeColors)

Saves this barcode to the specified file in EPS (Encapsulated PostScript) format with CMYK color space.

Declaration
public void SaveEpsImage(string filename, Encoding encoding, EpsCmykBarcodeColors cmykBarcodeColors)
Parameters
Type Name Description
System.String filename

A string that contains the name of the file to which to save this barcode.
System.Text.Encoding encoding

The Encoding object used for writing the file stream object.
EpsCmykBarcodeColors cmykBarcodeColors

The CMYK colors for each part of the barcode.

SaveViewState()

Declaration
protected override object SaveViewState()
Returns
Type Description
System.Object
Overrides
System.Web.UI.WebControls.WebControl.SaveViewState()

SaveWbmpImage(Stream)

Saves this barcode image to the specified Stream object in Wireless Bitmap (WBMP) image format.

Declaration
public void SaveWbmpImage(Stream stream)
Parameters
Type Name Description
System.IO.Stream stream

The Stream object to which to save this barcode image.

SaveWbmpImage(String)

Saves this barcode image to the specified file in Wireless Bitmap (WBMP) image format.

Declaration
public void SaveWbmpImage(string filename)
Parameters
Type Name Description
System.String filename

A string that contains the name of the file to which to save this barcode image.

TrackViewState()

Declaration
protected override void TrackViewState()
Overrides
System.Web.UI.WebControls.WebControl.TrackViewState()