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
Inherited Members
Namespace:Neodynamic.WebControls.BarcodeProfessional
Assembly:Neodynamic.WebControls.BarcodeProfessional.dll
Syntax
[DefaultProperty("Code")]
[ToolboxData("<{0}:BarcodeProfessional runat=\"server\"></{0}:BarcodeProfessional>")]
[Designer("Neodynamic.WebControls.Design.BarcodeProfessionalDesigner, Neodynamic.WebControls.Design.BarcodeProfessional, Version=8.0.2000.0, Culture=neutral, PublicKeyToken=c6b33c3093a0d4cd")]
[Description("Neodynamic Barcode Professional allows you to quickly and easily add barcodes images into your ASP.NET Web applications including full design time development support.")]
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
[DefaultValue(true)]
[Description("Gets or sets whether checksum must be generated and attached to the value to encode.")]
[Category("Barcode")]
public bool AddChecksum { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
AlternateText
Declaration
[Description("Gets or sets the alternate text displayed in the Barcode Professional control when the barcode image is unavailable. Browsers that support the ToolTips feature display this text as a ToolTip.")]
[Bindable(true)]
[Category("Appearance")]
[DefaultValue("")]
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
[DefaultValue(false)]
[Description("Gets or sets whether AntiAlias effect must be applied to all the texts in the barcode image.")]
[Category("Appearance")]
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
[DefaultValue("")]
[Description("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.")]
[Category("Artwork")]
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
[DefaultValue("")]
[Description("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.")]
[Category("Artwork")]
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
[DefaultValue(100)]
[Description("Gets or sets the opacity [from 1 to 100 (fully opaque)] of the image logo file. Default is 100.")]
[Category("Artwork")]
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
[DefaultValue(20)]
[Description("Gets or sets the percentage used to resize the logo image based on the barcode symbol size. Default is 20.")]
[Category("Artwork")]
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))]
[DefaultValue(typeof (LogoPosition), "Top")]
[Description("Gets or sets the position of the logo image file on the barcode symbol. Default is Top.")]
[Category("Artwork")]
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
[DefaultValue(true)]
[Description("Gets or sets whether the barcode image is automatically resized to display its entire contents.")]
[Category("Layout")]
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
[DefaultValue("ISO-8859-1")]
[Description("Gets or sets the Encoding Name (Code Page) to be used for Aztec Code in Byte Compaction mode. Default it ISO-8859-1.")]
[Category("Symbology - Aztec Code")]
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
[DefaultValue(23)]
[Description("Gets or sets the Error Correction Percentage to apply for Aztec Code symbology. Default is 23.")]
[Category("Symbology - Aztec Code")]
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))]
[DefaultValue(typeof (AztecCodeFormat), "Auto")]
[Description("Gets or sets the Aztec Code Format to use on that symbology.")]
[Category("Symbology - Aztec Code")]
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
[DefaultValue(0.0417)]
[Description("Gets or sets the module size. The unit of measure must be specified to BarcodeUnit property.")]
[Category("Symbology - Aztec Code")]
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
[DefaultValue(false)]
[Description("Gets or sets whether tilde character should be processed when Aztec Code is being generated.")]
[Category("Symbology - Aztec Code")]
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
[DefaultValue(-1)]
[Description("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.")]
[Category("Symbology - Aztec Code")]
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))]
[DefaultValue(typeof (BarcodeUnit), "Inch")]
[Description("Gets or sets the unit of measure for the barcode dimensions. Defauls is Inch. It must precede any barcode dimension properties settings.")]
[Category("Layout")]
public BarcodeUnit BarcodeUnit { get; set; }
Property Value
Type | Description |
---|---|
BarcodeUnit |
BarColor
Gets or sets the bars' color of the barcode.
Declaration
[DefaultValue(typeof (Color), "Black")]
[Description("Gets or sets the bars' color of the barcode.")]
[Category("Appearance")]
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
[DefaultValue(0.4)]
[Description("Gets or sets the bars' height of the barcode. The unit of measure must be specified to BarcodeUnit property.")]
[Category("Barcode")]
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
[DefaultValue(2)]
[Description("Gets or sets the wide bars' width compared to the narrow bars' width. In barcode terminology this is N value.")]
[Category("Barcode")]
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
[DefaultValue(0.01042)]
[Description("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.")]
[Category("Barcode")]
public double BarWidth { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
BarWidthAdjustment
Gets or sets the Bar Width Adjustment.
Declaration
[DefaultValue(0)]
[Description("Gets or sets the Bar Width Adjustment.")]
[Category("Barcode")]
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))]
[DefaultValue(typeof (BearerBarStyle), "None")]
[Description("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.")]
[Category("Appearance")]
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
[DefaultValue(0.05)]
[Description("Gets or sets the bearer bars' width. The unit of measure must be specified to BarcodeUnit property.")]
[Category("Appearance")]
public double BearerBarWidth { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
BorderStyle
Declaration
[Browsable(false)]
[DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
[EditorBrowsable(EditorBrowsableState.Never)]
public override BorderStyle BorderStyle { get; }
Property Value
Type | Description |
---|---|
System.Web.UI.WebControls.BorderStyle |
Overrides
BorderWidth
Declaration
public override Unit BorderWidth { get; set; }
Property Value
Type | Description |
---|---|
System.Web.UI.WebControls.Unit |
Overrides
BottomMargin
Gets or sets the height of the margin below the barcode bars. The unit of measure must be specified to BarcodeUnit property.
Declaration
[DefaultValue(0)]
[Description("Gets or sets the height of the margin below the barcode bars. The unit of measure must be specified to BarcodeUnit property.")]
[Category("Layout")]
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
[DefaultValue(0)]
[Description("Gets or sets the extra space inside the bottom border. The unit of measure must be specified to BarcodeUnit property.")]
[Category("Layout")]
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
[Description("Gets or sets the time at which the output image expires and is removed from the server cache.")]
[Category("Caching And Rendering")]
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
[DefaultValue(-1)]
[Description("Gets or sets the number of seconds that the server can cache the output image.")]
[Category("Caching And Rendering")]
public int CacheExpiresInSeconds { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
CodabarStartChar
Gets or sets the start character for Codabar symbology. Possible values are: A, B, C or D.
Declaration
[TypeConverter(typeof (CodabarStartStopChar))]
[DefaultValue(typeof (CodabarStartStopChar), "A")]
[Description("Gets or sets the start character for Codabar symbology. Possible values are: A, B, C or D.")]
[Category("Symbology - Codabar")]
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))]
[DefaultValue(typeof (CodabarStartStopChar), "B")]
[Description("Gets or sets the stop character for Codabar symbology. Possible values are: A, B, C or D.")]
[Category("Symbology - Codabar")]
public CodabarStartStopChar CodabarStopChar { get; set; }
Property Value
Type | Description |
---|---|
CodabarStartStopChar |
Code
Gets or sets the value to encode.
Declaration
[Bindable(true)]
[DefaultValue("")]
[Description("Gets or sets the value to encode.")]
[Category("Barcode")]
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
[TypeConverter(typeof (Code128))]
[DefaultValue(typeof (Code128), "Auto")]
[Description("Gets or sets the characters set to use in the Code 128 symbology. Possible values are: Auto, A, B or C.")]
[Category("Symbology - Code 128")]
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))]
[DefaultValue(typeof (Code16k), "Mode0")]
[Description("Gets or sets the mode to use for Code16k symbology. Modes supported are: Mode 0, 1, and 2.")]
[Category("Symbology - Code 16k")]
public Code16k Code16kMode { get; set; }
Property Value
Type | Description |
---|---|
Code16k |
CodeAlignment
Gets or sets the text alignment for Code property.
Declaration
[TypeConverter(typeof (Alignment))]
[DefaultValue(typeof (Alignment), "BelowCenter")]
[Description("Gets or sets the text alignment for Code property.")]
[Category("Appearance")]
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
[Category("Appearance")]
[DefaultValue("")]
[Description("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).")]
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
[DefaultValue("ISO-8859-1")]
[Description("Gets or sets the Encoding Name (Code Page) to be used for DataMatrix Byte Compaction mode. Default it ISO-8859-1.")]
[Category("Symbology - DataMatrix")]
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))]
[DefaultValue(typeof (DataMatrixEncoding), "Auto")]
[Description("Gets or sets the DataMatrix Encoding to use on that symbology.")]
[Category("Symbology - DataMatrix")]
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
[DefaultValue("001001")]
[Description("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.")]
[Category("Symbology - DataMatrix")]
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))]
[DefaultValue(typeof (DataMatrixFormat), "Auto")]
[Description("Gets or sets the DataMatrix Format to use on that symbology.")]
[Category("Symbology - DataMatrix")]
public DataMatrixFormat DataMatrixFormat { get; set; }
Property Value
Type | Description |
---|---|
DataMatrixFormat |
DataMatrixModuleSize
Gets or sets the module size. The unit of measure must be specified to BarcodeUnit property.
Declaration
[DefaultValue(0.0417)]
[Description("Gets or sets the module size. The unit of measure must be specified to BarcodeUnit property.")]
[Category("Symbology - DataMatrix")]
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
[DefaultValue(false)]
[Description("Gets or sets whether tilde character should be processed when DataMatrix code is being generated.")]
[Category("Symbology - DataMatrix")]
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
[DefaultValue(1)]
[Description("Gets or sets the number of Data Matrix symbols. Its value must be less than or equal to 16.")]
[Category("Symbology - DataMatrix")]
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
[DefaultValue(1)]
[Description("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.")]
[Category("Symbology - DataMatrix")]
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
[DefaultValue(true)]
[Description("Gets or sets whether checksum value must be displayed after the value to encode in the barcode image.")]
[Category("Appearance")]
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
[DefaultValue(true)]
[Description("Gets or sets whether the value to encode must be displayed in the barcode image.")]
[Category("Appearance")]
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
[DefaultValue(false)]
[Description("Gets or sets whether light margin indicators must be displayed in the barcode image. Only available for EAN/UPC Symbologies.")]
[Category("Appearance")]
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
[DefaultValue(true)]
[Description("Gets or sets whether start and stop characters must be displayed in the barcode image.")]
[Category("Appearance")]
public bool DisplayStartStopChar { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Dpi
Gets or sets the barcode image resolution in dots per inch.
Declaration
[DefaultValue(96F)]
[Description("Gets or sets the barcode image resolution in dots per inch.")]
[Category("Appearance")]
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
[DefaultValue(false)]
[Description("Gets or sets whether the recommended Bar Width Adjustment for digits 1, 2, 7 and 8 by GS1 spec is enabled. Default is False.")]
[Category("Symbology - EAN And UPC")]
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
[DefaultValue(0F)]
[Description("Gets or sets the Magnification Factor for EAN/UPC barcodes. Default is 0 (Zero/Disabled).")]
[Category("Symbology - EAN And UPC")]
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))]
[DefaultValue(typeof (Supplement), "None")]
[Description("Gets or sets the supplement type to use with EAN and UPC symbologies.")]
[Category("Symbology - EAN And UPC")]
public Supplement EanUpcSupplement { get; set; }
Property Value
Type | Description |
---|---|
Supplement |
EanUpcSupplementCode
Gets or sets the supplement value for EAN and UPC symbologies.
Declaration
[DefaultValue("0")]
[Description("Gets or sets the supplement value for EAN and UPC symbologies.")]
[Category("Symbology - EAN And UPC")]
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
[DefaultValue(0.15)]
[Description("Gets or sets the gap separation between the barcode and its supplement. The unit of measure must be specified to BarcodeUnit property.")]
[Category("Symbology - EAN And UPC")]
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
[DefaultValue(0.15)]
[Description("Gets or sets the height of the margin above the EAN/UPC supplement bars. The unit of measure must be specified to BarcodeUnit property.")]
[Category("Symbology - EAN And UPC")]
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
[DefaultValue(false)]
[Description("Gets or sets whether the barcode image is embedded into the page as a Base64 image. Default is false.")]
[Category("Appearance")]
public bool EmbedAsBase64Image { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Enabled
Declaration
[Browsable(false)]
[EditorBrowsable(EditorBrowsableState.Never)]
public override bool Enabled { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Overrides
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))]
[DefaultValue(typeof (ErrorBehavior), "BlankImage")]
[Description("Gets or sets what output type Barcode Professional will generate if an error occurs during barcode rendering. Default is BlankImage.")]
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
[DefaultValue(true)]
[Description("Gets or sets whether the extended versions for Code 39 and/or Code 93 symbologies must be used.")]
[Category("Symbology - Code 39 And Code 93")]
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
[DefaultValue(typeof (SizeF), "0,0")]
[Description("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.")]
[Category("Layout")]
public SizeF FitBarsAreaToSize { get; set; }
Property Value
Type | Description |
---|---|
System.Drawing.SizeF |
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
[DefaultValue(false)]
[Description("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.")]
[Category("Appearance")]
public bool GS1DataStrictValidation { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
GuardBar
Gets or sets whether guard bars must be drawn.
Declaration
[DefaultValue(true)]
[Description("Gets or sets whether guard bars must be drawn.")]
[Category("Symbology - EAN And UPC")]
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
[DefaultValue(0.5)]
[Description("Gets or sets the guard bars' height. The unit of measure must be specified to BarcodeUnit property.")]
[Category("Symbology - EAN And UPC")]
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
[DefaultValue("ISO-8859-1")]
[Description("Gets or sets the Encoding Name (Code Page) to be used for Han Xin Code Byte Encoding mode. Default it ISO-8859-1.")]
[Category("Symbology - Han Xin Code")]
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))]
[DefaultValue(typeof (HanXinCodeEncoding), "Auto")]
[Description("Gets or sets the Han Xin Code Encoding to use on that symbology.")]
[Category("Symbology - Han Xin Code")]
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))]
[DefaultValue(typeof (HanXinCodeErrorCorrectionLevel), "L1")]
[Description("Gets or sets the Error Correction Level to apply for Han Xin Code symbology.")]
[Category("Symbology - Han Xin Code")]
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
[DefaultValue(0.0417)]
[Description("Gets or sets the module size. The unit of measure must be specified to BarcodeUnit property.")]
[Category("Symbology - Han Xin Code")]
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
[DefaultValue(false)]
[Description("Gets or sets whether tilde character should be processed when Han Xin Code is being generated.")]
[Category("Symbology - Han Xin Code")]
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))]
[DefaultValue(typeof (HanXinCodeVersion), "Auto")]
[Description("Gets or sets the Han Xin Code Version to use on that symbology.")]
[Category("Symbology - Han Xin Code")]
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
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
[DefaultValue(true)]
[Description("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.")]
[Category("Symbology - HIBC")]
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
[DefaultValue(false)]
[Description("Gets or sets whether the recommended Bar Width Adjustment for digits 1, 2, 7 and 8 by GS1 spec is enabled. Default is False.")]
[Category("Symbology - HIBC")]
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
[DefaultValue(false)]
[Description("Gets or sets whether imaging quantification process must be applied in order to obtain high quality barcodes in GIF format.")]
[Category("Appearance")]
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)]
[Category("Appearance")]
[DefaultValue("")]
[Description("Gets or sets the Human Readable Text to be displayed instead of the value to encode specified in the Code property.")]
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))]
[DefaultValue(typeof (BarcodeImageFormat), "Gif")]
[Description("Gets or sets the barcode image format to render.")]
[Category("Appearance")]
public BarcodeImageFormat ImageFormat { get; set; }
Property Value
Type | Description |
---|---|
BarcodeImageFormat |
IsbnSupplementCode
(Obsolete) Do not use IsbnSupplementCode property. Use EanUpcSupplementCode property instead.
Declaration
[Browsable(false)]
[EditorBrowsable(EditorBrowsableState.Never)]
[DefaultValue("90000")]
[Description("Gets or sets the supplement value for ISBN symbology. It generally is the suggested price.")]
[Category("Symbology - ISBN Bookland EAN")]
[Obsolete("Do not use IsbnSupplementCode property. Use EanUpcSupplementCode property instead.")]
public string IsbnSupplementCode { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Isbt128DataStructure
Gets or sets the ISBT 128 Data Structure to be generated.
Declaration
[TypeConverter(typeof (Isbt128DataStructure))]
[DefaultValue(typeof (Isbt128DataStructure), "DS001")]
[Description("Gets or sets the ISBT 128 Data Structure to be generated.")]
[Category("Symbology - ISBT 128")]
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
[Description("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.")]
[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
Itf14LeftHMark
Gets or sets the H mark type for the left side of ITF-14 barcode symbol. Default is None.
Declaration
[TypeConverter(typeof (ItfHmark))]
[DefaultValue(typeof (ItfHmark), "None")]
[Description("Gets or sets the H mark type for the left side of ITF-14 barcode symbol. Default is None.")]
[Category("Symbology - ITF")]
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))]
[DefaultValue(typeof (ItfHmark), "None")]
[Description("Gets or sets the H mark type for the right side of ITF-14 barcode symbol. Default is None.")]
[Category("Symbology - ITF")]
public ItfHmark Itf14RightHMark { get; set; }
Property Value
Type | Description |
---|---|
ItfHmark |
LeftPadding
Gets or sets the extra space inside the left border. The unit of measure must be specified to BarcodeUnit property.
Declaration
[DefaultValue(0)]
[Description("Gets or sets the extra space inside the left border. The unit of measure must be specified to BarcodeUnit property.")]
[Category("Layout")]
public double LeftPadding { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
LicenseKey
Gets or sets the License Key.
Declaration
[DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
[Browsable(false)]
public static string LicenseKey { get; set; }
Property Value
Type | Description |
---|---|
System.String |
LicenseOwner
Gets or sets the License Owner.
Declaration
[DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
[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
[DefaultValue(true)]
[Description("Gets or sets whether the MaxiCode symbol is drawn by using a Pixel Based method; otherwise, a Vector based method is used.")]
[Category("Appearance")]
public bool MaxiCodeDrawPixelBasedSymbol { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
MaxiCodeMode
Gets or sets the MaxiCode mode.
Declaration
[TypeConverter(typeof (MaxiCodeModes))]
[DefaultValue(typeof (MaxiCodeModes), "Mode4")]
[Description("Gets or sets the MaxiCode mode.")]
[Category("Symbology - MaxiCode")]
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
[DefaultValue(false)]
[Description("Gets or sets whether tilde character should be processed when MaxiCode code is being generated.")]
[Category("Symbology - MaxiCode")]
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
[DefaultValue(1)]
[Description("Gets or sets the number of MaxiCode symbols in a Structured Appended format. Its value must be less than or equal to 8.")]
[Category("Symbology - MaxiCode")]
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
[DefaultValue(1)]
[Description("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.")]
[Category("Symbology - MaxiCode")]
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
[DefaultValue(0.117)]
[Description("Gets or sets the height of the MICR characters. The unit of measure must be specified to BarcodeUnit property.")]
[Category("Symbology - MICR")]
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
[DefaultValue("0.125")]
[Description("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.")]
[Category("Symbology - MICR")]
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
[DefaultValue("0.091")]
[Description("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.")]
[Category("Symbology - MICR")]
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))]
[DefaultValue(typeof (MicroPdf417Version), "Auto")]
[Description("Gets or sets the MicroPDF417 version (a predefined combinations of numbers of columns and rows) to be generated.")]
[Category("Symbology - PDF417")]
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))]
[DefaultValue(typeof (MicroQRCodeVersion), "Auto")]
[Description("Gets or sets the Micro QR Code Version to use on that symbology.")]
[Category("Symbology - QR Code")]
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
[DefaultValue(false)]
[Description("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.")]
[Category("Appearance")]
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))]
[DefaultValue(typeof (MsiChecksum), "OneMod10")]
[Description("Gets or sets the checksum mode to be used on MSI symbology.")]
[Category("Symbology - MSI")]
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
[DefaultValue(0)]
[Description("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).")]
[Category("Symbology - PDF417")]
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
[DefaultValue("ISO-8859-1")]
[Description("Gets or sets the Encoding Name (Code Page) to be used for PDF417 Byte Compaction mode. Default it ISO-8859-1.")]
[Category("Symbology - PDF417")]
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
[DefaultValue(5)]
[Description("Gets or sets the number of columns to use for PDF417 symbology.")]
[Category("Symbology - PDF417")]
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))]
[DefaultValue(typeof (Pdf417CompactionType), "Binary")]
[Description("Gets or sets the Compaction Type to apply for PDF417 symbology.")]
[Category("Symbology - PDF417")]
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))]
[DefaultValue(typeof (Pdf417ErrorCorrection), "Level2")]
[Description("Gets or sets the Error Correction Level to apply for PDF417 symbology.")]
[Category("Symbology - PDF417")]
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
[DefaultValue("000")]
[Description("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.")]
[Category("Symbology - PDF417")]
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
[DefaultValue(0)]
[Description("Gets or sets the number of rows to use for PDF417 symbology.")]
[Category("Symbology - PDF417")]
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
[DefaultValue(0)]
[Description("Gets or sets the number of Macro PDF417 symbols. Its value must be less than or equal to 99999.")]
[Category("Symbology - PDF417")]
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
[DefaultValue(0)]
[Description("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.")]
[Category("Symbology - PDF417")]
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
[DefaultValue(false)]
[Description("Gets or sets whether the right side of PDF417 barcode is truncated (removed).")]
[Category("Symbology - PDF417")]
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
[DefaultValue(0.0417)]
[Description("Gets or sets the gap between Pharmacode bars. The unit of measure must be specified to BarcodeUnit property.")]
[Category("Symbology - Pharmacode")]
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
[DefaultValue(0.0625)]
[Description("Gets or sets the width of Pharmacode Thick Bars. The unit of measure must be specified to BarcodeUnit property.")]
[Category("Symbology - Pharmacode")]
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
[DefaultValue(0.0208)]
[Description("Gets or sets the width of Pharmacode Thin Bars. The unit of measure must be specified to BarcodeUnit property.")]
[Category("Symbology - Pharmacode")]
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
[DefaultValue(0.06)]
[Description("Gets or sets the short bars' height of Planet symbology. The unit of measure must be specified to BarcodeUnit property.")]
[Category("Symbology - Planet")]
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
[DefaultValue(0.135)]
[Description("Gets or sets the tall bars' height of Planet symbology. The unit of measure must be specified to BarcodeUnit property.")]
[Category("Symbology - Planet")]
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
[DefaultValue(true)]
[Description("Gets or sets whether start and stop characters must be added and drawn in the barcode image.")]
[Category("Symbology - Postal 4-State")]
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
[DefaultValue(0.0313)]
[Description("Gets or sets the gap spacing between bars. The unit of measure must be specified to BarcodeUnit property.")]
[Category("Symbology - Postal 4-State")]
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
[DefaultValue(0.08)]
[Description("Gets or sets the tracker bar's height. The unit of measure must be specified to BarcodeUnit property.")]
[Category("Symbology - Postal 4-State")]
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
[DefaultValue(0.0208)]
[Description("Gets or sets the tracker bar's width. The unit of measure must be specified to BarcodeUnit property.")]
[Category("Symbology - Postal 4-State")]
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
[DefaultValue(0.06)]
[Description("Gets or sets the short bars' height of Postnet symbology. The unit of measure must be specified to BarcodeUnit property.")]
[Category("Symbology - Postnet")]
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
[DefaultValue(0.135)]
[Description("Gets or sets the tall bars' height of Postnet symbology. The unit of measure must be specified to BarcodeUnit property.")]
[Category("Symbology - Postnet")]
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
[DefaultValue("ISO-8859-1")]
[Description("Gets or sets the Encoding Name (Code Page) to be used for QR Code Byte Compaction mode. Default it ISO-8859-1.")]
[Category("Symbology - QR Code")]
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))]
[DefaultValue(typeof (QRCodeEncoding), "Auto")]
[Description("Gets or sets the QR Code Encoding to use on that symbology.")]
[Category("Symbology - QR Code")]
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))]
[DefaultValue(typeof (QRCodeErrorCorrectionLevel), "M")]
[Description("Gets or sets the Error Correction Level to apply for QR Code symbology.")]
[Category("Symbology - QR Code")]
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
[DefaultValue(0.0417)]
[Description("Gets or sets the module size. The unit of measure must be specified to BarcodeUnit property.")]
[Category("Symbology - QR Code")]
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
[DefaultValue(false)]
[Description("Gets or sets whether tilde character should be processed when QR Code is being generated.")]
[Category("Symbology - QR Code")]
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))]
[DefaultValue(typeof (QRCodeVersion), "Auto")]
[Description("Gets or sets the QR Code Version to use on that symbology.")]
[Category("Symbology - QR Code")]
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
[DefaultValue(0.15)]
[Description("Gets or sets the quiet zone's width. The unit of measure must be specified to BarcodeUnit property.")]
[Category("Barcode")]
public double QuietZoneWidth { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
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))]
[DefaultValue(typeof (RenderingMethod), "Default")]
[Description("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: <httpHandlers><add verb=\"*\" path=\"BarcodeProfessional.aspx\" type=\"Neodynamic.WebControls.BarcodeProfessional.BarcodeProfessional, Neodynamic.WebControls.BarcodeProfessional\"/></httpHandlers>")]
[Category("Caching And Rendering")]
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
[DefaultValue(0)]
[Description("Gets or sets the extra space inside the right border. The unit of measure must be specified to BarcodeUnit property.")]
[Category("Layout")]
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))]
[DefaultValue(typeof (Rotate), "None")]
[Description("Gets or sets the rotation angle to apply on the barcode image.")]
[Category("Appearance")]
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
[DefaultValue(4)]
[Description("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.")]
[Category("Symbology - GS1 DataBar Expanded Stacked")]
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
[Category("Appearance")]
[DefaultValue(false)]
[Description("Gets or sets a value that determines whether barcode drawing should use device-specific pixel settings during rendering. Default value is false.")]
public bool SnapsToDevicePixels { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Symbology
Gets or sets the barcode symbology to generate.
Declaration
[TypeConverter(typeof (Symbology))]
[DefaultValue(typeof (Symbology), "Code39")]
[Description("Gets or sets the barcode symbology to generate.")]
[Category("Barcode")]
[Editor("Neodynamic.WebControls.Design.SymbologyEditor, Neodynamic.WebControls.Design.BarcodeProfessional, Version=7.0.2000.0, Culture=neutral, PublicKeyToken=c6b33c3093a0d4cd", typeof (UITypeEditor))]
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))]
[DefaultValue(typeof (TelepenEncoding), "Ascii")]
[Description("Gets or sets the Telepen Encoding to use on that symbology.")]
[Category("Symbology - Telepen")]
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))]
[DefaultValue(typeof (TemporaryStorage), "Default")]
[Description("Gets or sets the temporary storage for the barcode content when rendering the src attribute of the HTML Image Tag representing the barcode image.")]
[Category("Caching And Rendering")]
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)]
[Category("Appearance")]
[DefaultValue("")]
[Description("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.")]
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))]
[DefaultValue(typeof (Alignment), "AboveCenter")]
[Description("Gets or sets the text alignment for Text property.")]
[Category("Appearance")]
public Alignment TextAlignment { get; set; }
Property Value
Type | Description |
---|---|
Alignment |
TextFont
Gets the FontInfo object for using when rendering Text property.
Declaration
[Bindable(true)]
[DesignerSerializationVisibility(DesignerSerializationVisibility.Content)]
[NotifyParentProperty(true)]
[Category("Appearance")]
[Description("The font for the Text property.")]
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
[DefaultValue(typeof (Color), "Black")]
[Description("Gets or sets the text color for using when rendering Text property.")]
[Category("Appearance")]
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
[Category("Appearance")]
[DefaultValue("")]
[Description("Gets or sets the string pattern to format the Text property. Based on String.Format(). Default value is empty (Disabled).")]
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
[DefaultValue(typeof (TiffCompression), "LZW")]
[Description("Gets or sets the TIFF compression algorithm to be used when saving barcodes in such image format.")]
[Category("Appearance")]
public TiffCompression TiffCompression { get; set; }
Property Value
Type | Description |
---|---|
TiffCompression |
TopMargin
Gets or sets the height of the margin above the barcode bars. The unit of measure must be specified to BarcodeUnit property.
Declaration
[DefaultValue(0)]
[Description("Gets or sets the height of the margin above the barcode bars. The unit of measure must be specified to BarcodeUnit property.")]
[Category("Layout")]
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
[DefaultValue(0)]
[Description("Gets or sets the extra space inside the top border. The unit of measure must be specified to BarcodeUnit property.")]
[Category("Layout")]
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))]
[DefaultValue(typeof (UpcE), "System0")]
[Description("Gets or sets the number system to use for UPC-E symbology.")]
[Category("Symbology - EAN And UPC")]
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
[DefaultValue(false)]
[Description("Gets or sets whether absolute full URL must be used when rendering the source attribute of the barcode image tag.")]
[Category("Caching And Rendering")]
[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
[DefaultValue(false)]
[Description("Gets or sets whether the barcode image should be stored in the ASP.NET Output Cache.")]
[Category("Caching And Rendering")]
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
[DefaultValue(false)]
[Description("Gets or sets whether quiet zones are used for drawing Text and/or Code properties.")]
[Category("Appearance")]
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))]
[DefaultValue(typeof (FIM), "A")]
[Description("Gets or sets the USPS FIM pattern to use on that symbology.")]
[Category("Symbology - USPS FIM")]
public FIM UspsFimPattern { get; set; }
Property Value
Type | Description |
---|---|
FIM |
UspsHorizontalBarsCount
Gets or sets the number of horizontal bars to be drawn.
Declaration
[DefaultValue(10)]
[Description("Gets or sets the number of horizontal bars to be drawn.")]
[Category("Symbology - USPS Horizontal Bars")]
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
Methods
Clone()
Declaration
public object Clone()
Returns
Type | Description |
---|---|
System.Object |
Implements
CreateControlCollection()
Declaration
protected override ControlCollection CreateControlCollection()
Returns
Type | Description |
---|---|
System.Web.UI.ControlCollection |
Overrides
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
OnInit(EventArgs)
Declaration
protected override void OnInit(EventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.EventArgs | e |
Overrides
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
Render(HtmlTextWriter)
Declaration
protected override void Render(HtmlTextWriter writer)
Parameters
Type | Name | Description |
---|---|---|
System.Web.UI.HtmlTextWriter | writer |
Overrides
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
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()