Chapter 12. Barcode Object Properties and Methods Reference

Table of Contents

12.1. General
12.1.1. Properties
12.1.2. Methods
12.1.3. Deprecated Properties
12.2. AutoLabelSize Property
12.3. AutoSize Property
12.4. BackColor, ForeColor Properties
12.5. BarHeight Property
12.6. BearerBars Property
12.7. BorderColor Property
12.8. BorderStyle Property
12.9. BorderWidth Property
12.10. Code25OptionalCheckDigit Property
12.11. Code39OptionalCheckDigit Property
12.12. Code39StartStopChars Property
12.13. Comment Property
12.14. CommentAlignment Property
12.15. CommentFont Property
12.16. CommentMarginTop, CommentMarginBottom, CommentMarginLeft, CommentMarginRight Properties
12.17. CommentOnTop Property
12.18. DataMatrixModuleSize Property
12.19. DataMatrixTargetSizeID Property
12.20. Font Property
12.21. I2of5OptionalCheckDigit Property
12.22. LabelWidth, LabelHeight Properties
12.23. MaxicodeClass Property
12.24. MaxicodeMode Property
12.25. MaxicodeCountryCode Property
12.26. MaxicodeZipCode Property
12.27. Measurement Property
12.28. Message Property
12.29. NarrowBarWidth Property
12.30. NarrowToWideRatio Property
12.31. PDFAspectRatio Property
12.32. PDFMaxCols Property
12.33. PDFMaxRows Property
12.34. PDFModuleHeight Property
12.35. PDFModuleWidth Property
12.36. PDFSecurityLevel Property
12.37. PDFTruncatedSymbol Property
12.38. Picture Property
12.39. QuietZones Property
12.40. RasterImageResolution Property
12.41. Rotation Property
12.42. ShowCheckDigit Property
12.43. ShowComment Property
12.44. ShowHRText Property
12.45. Symbology Property
12.46. SymbolMarginTop, SymbolMarginBottom, SymbolMarginLeft, SymbolMarginRight Properties
12.47. TexAlignment Property
12.48. TextOnTop Property
12.49. UccEanOptionalCheckDigit Property
12.50. ZoomRatio Property
12.51. About Method
12.52. ExportImage Method
12.53. Load Method
12.54. Save Method
12.55. Refresh Method

12.1. General

All properties and methods are listed in this chapter. Some properties are now obsolete and kept only for backward-compatiblity reason. Properties related to two dimensional barcodes (property names started with PDF, DataMatrix and MaxiCode) are not present in the lite version.

Some properties may not be modifiable under certain design mode. Some properties may be related to other properties - i.e. change to one property will change other properties. For example, Changing Symbology property will also alter the value of Message property.

12.1.1. Properties

Table 12.1. List of Barcode Object Properties

AutoLabelSize Determines whether the current work mode is under barcode design mode or the label design mode.
AutoSizeDetermines which party controls the sizing of the control.
BackColorSpecifies the background color for the control.
BarHeightSpecifies the height of the bars in the control, in user units.
BearerBarsDetermines whether to include the bearer bars around the barcodes. applicable on selected symbologies.
BorderColorSpecifies the border color for the control.
BorderStyleSpecifies the border style.
BorderWidthSpecifies the border with, in logical units
Code25OptionalCheckDigitDetermines whether to include an optional checksum digit in all Code25 barcodes.
Code39OptionalCheckDigitDetermines whether to include an optional checksum digit in all code 39 barcodes.
Code39StartStopCharsDetermines whether to display the start and stop characters in the human readable of all code 39 barcodes.
CommentSpecifies the string for the human readable comment printed around the barcode.
CommentAlignmentDetermines how the text paragraphs are aligned within the comment.
CommentFontSpecifies the font used to draw comment text.
CommentMarginBottomSpecifies the margin on the bottom of the comment box.
CommentMarginLeftSpecifies the margin on the left of the comment box.
CommentMarginRightSpecifies the margin on the right of the comment box.
CommentMarginTopSpecifies the margin on the top of the comment box.
CommentOnTopDetermines whether the comment box is placed above the barcode image.
DataMatrixTargetSizeID[a]Specifies the size of the Data Matrix barcode created.
FontSpecifies the font used to draw human readable text.
ForeColorSpecifies the foreground color of the control.
I2of5OptionalCheckDigitDeprecated in version 3.4.
LabelHeightSpecifies the height of the label (working area).
LabelWidthSpecifies the width of the label (working area).
MaxicodeClass[a]Specifies the service class for the structured carrier message in MaxiCode symbols.
MaxicodeCountryCode[a]Specifies the country code for the structured carrier message in MaxiCode symbols.
MaxicodeMode[a]Specifies the encoding mode for the Maxicode symbols.
MaxicodeZipCode[a]Specifies the zip/postal code for the structured carrier message in MaxiCode symbols.
MeasurementSpecifies the measurement unit for all length properties.
MessageSpecifies a string which represents the data to be encoded.
NarrowBarWidthSpecifies the width of the narrowest module in linear symbologies.
NarrowToWideRatioSpecifies the ratio used to calculate the width of the wide element. Applicable on selected symbologies.
PDFAspectRatio[a]Specifies the overall height to width ratio of the PDF417 barcodes created.
PDFMaxCols[a]Specifies the maximum number of codeword columns to allow in the PDF417 barcodes created.
PDFMaxRows[a]Specifies the maximum number of codeword columns to allow in the PDF417 barcodes created.
PDFModuleHeight[a]Specifies the height of the module in the PDF417 barcodes created.
PDFModuleWidth[a]Specifies the width of the module in the PDF417 barcodes created.
PDFSecurityLevel[a]Specifies the security level for error correction to use in PDF417 barcodes.
PDFTruncatedSymbol[a]Determines whether to create the truncated version of PdF417 barcodes.
PictureReturns a snapshot of the drawing in Windows Enhanced Metafile Format (EMF).
QuietZonesDetermines whether to include quiet zones in the barcodes.
RasterImageResolutionSpecifies the resolution which is used to export raster images.
RotationSpecifies the orientation of the working area in degrees.
ShowCheckDigitDetermines whether to include the checksum character in the human readable.
ShowCommentDetermines whether the control displays the comment element.
ShowHRTextDetermines whether to display the human readable text.
SymbolMarginBottomSpecifies the margins on the bottom of the symbol.
SymbolMarginLeftSpecifies the margins on the left of the symbol.
SymbolMarginRightSpecifies the margins on the right of the symbol.
SymbolMarginTopSpecifies the margins on the top of the symbol.
SymbologySpecifies the barcode format (symbology)
TexAlignmentSpecifies how the human readable text is aligned.
TextOnTopDetermines whether the human readable text is placed above the barcode image.
UccEanOptionalCheckDigitDeprecated in version 3.4
ZoomRatioSpecifies the scale ratio of the current display area vs. the natural size.

[a] Not applicable to lite version.


12.1.2. Methods

Table 12.2. List of Barcode Object Methods

AboutDisplays the About dialog.
ExportImageExports the drawing to a graphics file with the specified format.
LoadLoads the control properties from a file in binary or XML format.
SaveSaves the control properties to a file in binary or XML format.
RefreshForces the control redraws itself

12.1.3. Deprecated Properties

During the evolution of this product, some properties have been deprecated in major releases. Deprecated properties are no longer used in the implement. They are kept in the interface to retain backward compatibility. Existing applications require no change to use newer versions of the product. Setting values to deprecated properties render no effects.

Generally spearking, a property is deprecated because it is redundant, difficult to get it right at the first place, and confusing to our customers.

Table 12.3. List of Deprecated Properties

NameDeprecated SinceComment
BarWidthReduction3.2Pixel-based rendering method makes it obsolete.
I2of5OptionalCheckDigit3.4Interleave 2 of 5 requires input to be even. In version 3.4, a check digit is automatically calculated and appended if the input has an odd length. See Section 14.14, “Interleaved 2 of 5 (ITF25)” for more information.
UccEanOptionalCheckDigit3.4Since version 3.4, all GS1-128 applications that are known to the program that have mod 10 check digit will have the check digit calculated automatically and appended if necessary. See Section 14.12.3, “Auto Check Digit” for more information.

12.2. AutoLabelSize Property

Description

Returns or sets the value that determines the current work mode.

Syntax

object.AutoLabelSize[= Boolean] 

Remarks

Use this property to set/return the current work mode. When AutoLabelSize property is TRUE, the current work mode is barcode design mode; otherwise the label design mode is assumed. Under the barcode design mode, the size of the working area is not fixed. It grows or shrinks as the sizes of other components, such as margins, barcode and the comment change. Under barcode design mode, properties LabelWidth and LabelHeight are read-only and can not be altered.

On the contrary, under the label design mode, the size of the working area is fixed and can not be modified. Under the label design mode, anything beyond the working area is clipped.

If you intend to create a barcode as small as possible, choose the barcode design mode by setting this property to TRUE. If you'd like to print a full label with all components turned on, select the label design mode.

Note

When you switch AutoLabelSize from TRUE to FALSE, the predefined label size - 2 by 2 inches is assumed.

See Also

Section 12.22, “LabelWidth, LabelHeight Properties”

Section 12.3, “AutoSize Property”

12.3. AutoSize Property

Description

Returns or sets the value that defines how the control size is determined.

Syntax

object.AutoSize[= Boolean] 

Remarks

AutoSize controls how the object responds to the sizing request from the container. When AutoSize is FALSE, the object redraws itself to the maximum extent that the container specifies; otherwise it calculates the display size by multiplying its natural size with the ZoomRatio, and draws itself within the display size.

When AutoSize is changed from FALSE to TRUE, the ZoomRatio is changed back to 1.0.

See Also

Section 12.50, “ZoomRatio Property”

Section 12.2, “AutoLabelSize Property”

12.4. BackColor, ForeColor Properties

Description

BackColor - returns or sets the background color of the control.

ForeColor - returns or sets the foreground color of the control.

Syntax

object.BackColor[= Color] 
object.ForeColor[= Color] 

Remarks

For opening systems we strongly recommend to set the background color to solid white (0xFFFFFF) and foreground color to black (0x000000). Note: barcode requires decent contrast between the foreground color and the background color in order to be readable. Always test the readability thoroughly when you select a color pair different from black and white.

12.5. BarHeight Property

Description

BarHeight - returns or sets a value for the height of bars in Barcode control.

Syntax

object.BarHeight[= Number] 

Remarks

The BarHeight property specifies the height of the dark elements in all linear symbologies with exception (see notes below). The actual value is affected by the Measurement property. If Measurement is set to mbxMeasureEnglish, the unit for this property is mils (1/1000 inch) otherwise it is 1/1000 cm. The default value is 1000 which translates to 1 inch or 1 cm, depending on the measurement unit specified.

This property have no effect on the size of two-dimensional barcodes, such as PDF417, DataMatrix and MaxiCode.

The height of elements in postal symbologies (POSTNET and RoyalMail) is fixed. Therefore, changing this property has no effect on those types of barcodes.

The height of bars in a DataBar Truncated symbol is fixed at 13X (X is the industry term for NarrowBarWidth), and the height of a DataBar Stacked symbol is fixed at 50X. Therefore, this property does not affect the height of those two types of symbols.

In stacked symbologies (DataBar Stacked Omnidirectional and DataBar Expanded (multi-row), the overall height is the number of rows multiplying BarHeight, plus the height of any required separator rows.

12.6. BearerBars Property

Description

Returns or sets a value that determines whether to include bearer bars around the barcode.

Syntax

object.BearerBars[= Boolean] 

Remarks

Bearer bars (see below) are horizontal bars printed across the top and bottom of the barcode image. Bearer bars can help avoid partial reads should the reader move off the top or bottom of the code. Only certain symbologies require bearer bars (for example Interleaved 2 of 5) as the start and stop characters in most bar codes make bearer bars unnecessary.

In Barcode ActiveX the following symbologies can have bearer bars: Codabar, Code11, Code25, Code128, UCC/EAN-128, Code39, Code39 HIBC, Code 39 Full ASCII, Code93, Interleaved 2 of 5, MSI/Plessey and Telepen. Other symbologies ignore this property.

12.7. BorderColor Property

Description

Returns or sets the color of borders.

Syntax

object.Bordercolor[= Color] 

Remarks

Use this property to specify the border color of Barcode ActiveX. The default value is 0 (black).

See Also

Section 12.9, “BorderWidth Property”

Section 12.8, “BorderStyle Property”

12.8. BorderStyle Property

Description

BorderStyle - returns or sets a value that determines the border style.

Syntax

object.BorderStyle[= Number]

Remarks

Use BorderStyle property to specify the border style. This property is set by using one of the BorderStyle enumeration values:

Table 12.4. Border Styles

ConstantValueDescription
mbxBorderStyleNone0No border lines
mbxBorderStyleSolid1Solid line
mbxBorderStyleDash2Dash line
mbxBorderStyleDot3Dot line
mbxBorderStyleDashDot4Dash dot line
mbxBorderStyleDashDotDot5Dash dot dot line

See Also

Section 12.7, “BorderColor Property”

Section 12.9, “BorderWidth Property”

12.9. BorderWidth Property

Description

BorderWidth - returns or sets the value for the border width.

Syntax

object.BorderWidth[= Number] 

Remarks

Use BorderWidth property to specify a border width for the Barcode ActiveX. The border width is expressed in logical units prescribed by the Measurement property. For example, if you set this property to 15 and the Measurement is mbxMeasureEnglish, the border width is 15 mils (0.015 inch). The default value is 15.

To disable the border, set BorderWidth to 0 or BorderStyle to mbxBorderStyleNone.

See Also

Section 12.8, “BorderStyle Property”

Section 12.7, “BorderColor Property”

12.10.  Code25OptionalCheckDigit Property

Description

Code25OptionalCheckDigit - returns or sets a value that determines whether to include an optional checksum digit in all Code25 barcodes produced by Barcode ActiveX.

Syntax

object.Code25OptionalCheckDigit[= Boolean]

Remarks

A code 2 of 5 barcode can have an optional check digit. When the Code25OptionalCheckDigit is TRUE, a check digit is calculated using modulo 10 algorithm and added to a code 2 of 5 barcode. To display the checksum digit in the human readable text, set ShowCheckDigit to TRUE.

See Also

Section 14.7, “MSI/Plessey, Code 25 and Code11”

12.11. Code39OptionalCheckDigit Property

Description

Code39OptionalCheckDigit - returns or sets a value that determines whether to include an optional checksum digit in all Code39 barcodes produced by Barcode ActiveX.

Syntax

object.Code39OptionalCheckDigit[= Boolean]

Remarks

A code 3 of 9 symbol can have an optional check digit (character) at the end of the barcode. When the Code39OptionalCheckDigit property is set to TRUE, a check digit is calculated using modulo 43 method and appended to the end of the barcode. To display the checksum digit, set ShowCheckDigit to TRUE.

This property affects two symbologies: Code 39 and Code39 Full ASCII.

See Also

Section 14.2, “Code 39”

Section 14.3, “Code 39 Full ASCII”

12.12. Code39StartStopChars Property

Description

Returns or sets a value that determines whether to display the start and stop characters in the human readable text in all Code39 barcodes produced by Barcode ActiveX.

Syntax

object.Code39StartStopChars[= Boolean]

Remarks

For historical reasons many code39 symbols print start/stop characters (asterisks) at the beginning and the end of the human readable text. While the start and stop characters are always present in the barcode, it is not necessary for them to appear in the human readable. When the Code39StartStopChars property is set to TRUE, the asterisks are displayed at both the beginning and end of the human readable.

This property affects the three Code 39 symbologies - Code 39, HIBC and Code39 Full ASCII.

Note

The asterisks are not part of the encoded data; and you should not include asterisks in Message property when creating code 39 barcodes.

See Also

Section 14.2, “Code 39”

Section 14.4, “Code 39 HIBC”

Section 14.3, “Code 39 Full ASCII”

12.13. Comment Property

Description

Returns or sets a string for the human readable comment printed around the barcode symbol.

Syntax

object.Comment[= String] 

Remarks

In addition to the human readable, which always reflects the encoded data and conforms to the standard requirements, you can optionally place a paragraph of text beside the barcode image.

You may adjust margins around the comment, place the comment at the top or bottom, modify the font typeface as well as the size, and change how the text is aligned.

Control characters are not printed.

Note

It is now possible to enter multiple paragraphs in the comment by inserting \n at the end of each paragraph (except the last one). For example, the string First paragraph\nSecond Paragraph renders two paragraphs, as illustrated below:

See Also

Section 12.15, “CommentFont Property”

Section 12.14, “CommentAlignment Property”

Section 12.43, “ShowComment Property”

Section 12.17, “CommentOnTop Property”

Section 12.16, “CommentMarginTop, CommentMarginBottom, CommentMarginLeft, CommentMarginRight Properties”

12.14. CommentAlignment Property

Description

CommentAlignment - returns or sets a value indicating how the comment is aligned.

Syntax

object.CommentAlignment[= AligmentEnum] 

Remarks

This property controls how the text in the comment portion is aligned. Valid alignment choices are listed in the table below:

Table 12.5. CommentAlignment Options

ConstantValueDescription
mbxAlignLeft0Left alignment (default). Align the text to the left edge of the comment box.
mbxAlignRight1Right alignment. Align the text to the right edge of the comment box.
mbxAlignCenter2Center alignment. Align the text to the center of the comment box
mbxAlignJustify3Justify alignment. Align the text to both edge of the comment box.

12.15. CommentFont Property

Description

Returns or sets the font for comment text.

Syntax

object.CommentFont[= Font]

Remarks

The default font used to draw comment text is typeface of Arial, 8 points.

This property is used to retrieve/set the font used for comment text. To set/retrieve the font used for human readable text, use Font property.

In Visual Basic you cannot create a Font object using code like Dim X As New Font. If you want to create a Font object, you can use the StdFont object, as in the code below:

Dim X As New StdFont
X.Bold = True
X.Name = "Arial"
Dim rc As Long
obj.CommentFont = X

12.16. CommentMarginTop, CommentMarginBottom, CommentMarginLeft, CommentMarginRight Properties

Description

These four properties control the margins around the comment box.

Syntax

object.CommentMarginTop[= Number]
CommentMarginBottom[= Number]
CommentMarginLeft[= Number]
CommentMarginRight[= Number]

Remarks

The above four parameters control the margins around the comment text box. Note that under different design modes, the CommentMarginLeft and CommentMarginRight have different meanings. For detailed information refer to Chapter 5, Fundamentals.

12.17. CommentOnTop Property

Description

Returns or sets a value that determines whether the comment box is placed above or below the symbol.

Syntax

object.CommentOnTop[= Boolean]

Remarks

The default value for CommentOnTop is FALSE. To place the comment on top of the image, set this property to TRUE.

12.18. DataMatrixModuleSize Property

Description

Returns or sets a value that determines the width and height of a single cell in the data matrix symbols generated by Morovia Barcode ActiveX.

Syntax

object.DataMatrixModuleSize[= Number] 

Remarks

The real estateunit of a data matrix symbol, the module, is always square. This property sets both the width and the height of the square. It affects the overall symbol size.

The default value for DataMatrixModuleSize is 20 mils. The property can be any numbers between 1 and 100.

See Also

Section 12.19, “DataMatrixTargetSizeID Property”

12.19. DataMatrixTargetSizeID Property

Description

Returns or sets a value that determines the shape of the DataMatrix symbol produced by Morovia Barcode ActiveX.

Syntax

object.DataMatrixTargetSizeID[= Number] 

Remarks

Data Matrix only allows a limit number of combinations of rows and columns. You must set the property to 0 (automatic) or one of the following values:

Table 12.6. DataMatrixTargetSizeID options

ConstantValueDescription
mbxDMTargetSizeAuto0Automatic selection of data matrix size
mbxDMTargetSize_12X121Rectangle symbol of 12 by 12 modules
mbxDMTargetSize_14X142Rectangle symbol of 14 by 14 modules
mbxDMTargetSize_16X163Rectangle symbol of 16 by 16 modules
mbxDMTargetSize_18X184Rectangle symbol of 18 by 18 modules
mbxDMTargetSize_20X205Rectangle symbol of 20 by 20 modules
mbxDMTargetSize_22X226Rectangle symbol of 22 by 22 modules
mbxDMTargetSize_24X247Rectangle symbol of 24 by 24 modules
mbxDMTargetSize_26X268Rectangle symbol of 26 by 26 modules
mbxDMTargetSize_32X329Rectangle symbol of 32 by 32 modules
mbxDMTargetSize_36X3610Rectangle symbol of 36 by 36 modules
mbxDMTargetSize_40X4011Rectangle symbol of 40 by 40 modules
mbxDMTargetSize_44X4412Rectangle symbol of 44 by 44 modules
mbxDMTargetSize_48X4813Rectangle symbol of 48 by 48 modules
mbxDMTargetSize_52X5214Rectangle symbol of 52 by 52 modules
mbxDMTargetSize_64X6415Rectangle symbol of 64 by 64 modules
mbxDMTargetSize_72X7216Rectangle symbol of 72 by 72 modules
mbxDMTargetSize_80X8017Rectangle symbol of 80 by 80 modules
mbxDMTargetSize_88X8818Rectangle symbol of 88 by 88 modules
mbxDMTargetSize_96X9619Rectangle symbol of 96 by 96 modules
mbxDMTargetSize_104X10420Rectangle symbol of 104 by 104 modules
mbxDMTargetSize_120X12021Rectangle symbol of 120 by 120 modules
mbxDMTargetSize_132X13222Rectangle symbol of 132 by 132 modules
mbxDMTargetSize_144X14423Rectangle symbol of 144 by 144 modules
mbxDMTargetSize_8X1824Rectangle symbol of 8 by 18 modules
mbxDMTargetSize_8X3225Rectangle symbol of 8 by 32 modules
mbxDMTargetSize_12X2626Rectangle symbol of 12 by 26 modules
mbxDMTargetSize_12X3627Rectangle symbol of 12 by 36 modules
mbxDMTargetSize_16X3628Rectangle symbol of 16 by 36 modules
mbxDMTargetSize_16X4829Rectangle symbol of 16 by 48 modules
mbxDMTargetSize_10X1030Rectangle symbol of 10 by 10 modules

Data matrix offers limited combinations between the number of rows and columns. A valid selection is called a data matrix size. A data matrix symbol can be any one of the 30 shapes listed in table Table 12.6, “DataMatrixTargetSizeID options”. In addition, our software uses value 0 for automatic size selection. The value 0 means do not care. Barcode ActiveX selects the smallest size to fit your data when you set DataMatrixTargetSizeID to 0.

Note

The size ID for the smallest data matrix shape, mbxDMTargetSize_10X10, is 30.

See Also

Section 12.18, “DataMatrixModuleSize Property”

12.20. Font Property

Description

Returns or sets the font for human readable text.

Syntax

object.Font[= Font] 

Remarks

The default font used to draw comment text is typeface of Arial, 9 points. Generally speaking, you should use a sans-serif font for human readable text. Some industries require OCR-B(Optical Character Recognition Revision B) font to be used.

This property is used to retrieve/set font for human readable text. To set /retrieve font used for comment, use CommentFont property.

In Visual Basic you cannot create a Font object using code like Dim X As New Font. If you want to create a Font object, you can use the StdFont object, as demonstrated in the code below:

Dim X As New StdFont
X.Bold = True
X.Name = "Arial"
Dim rc As Long
obj.Font=X

See Also

Section 12.44, “ShowHRText Property”

Section 12.47, “TexAlignment Property”

Section 12.48, “TextOnTop Property”

12.21. I2of5OptionalCheckDigit Property

Description

Deprected since 3.4.

Syntax

object.I2of5OptionalCheckDigit[= Boolean] 

Remarks

Previously, in order to add check digit to an Interleaved 2 of 5 bracode, you need to set this property to TRUE. Interleaved 2 of 5 symbology requires the input to be even length. If this property is TRUE and the input already has even length, the previous implement appends a '0' at the end, and calculate the check digit. This is an unexected behavior for many customers.

In version 3.4 and above, this property has no effect on the barcode created. Whether or not a check digit is required depends on if the length of the input is even or odd. If the length is even, no check digit is added and Barcode ActiveX encodes as is. If the length is odd, however, the program calculates the check digit and automatically appends at the end to make the whole length even.

See Also

Section 14.14, “Interleaved 2 of 5 (ITF25)”

12.22. LabelWidth, LabelHeight Properties

Description

LabelWidth, LabelHeight - returns or sets the width and height of the working area, in measurement units specified by Measurement.

Syntax

object.LabelHeight[= Number]
object.LabelWidth[=Number] 

Remarks

Under label design mode, you need to set these two properties to the size of working area you plan to work on. The drawing can only be done within the working area; anything beyond the boundary will be clipped out.

If you are working on barcode design mode by setting AutoLabelSize to TRUE, you can not set these two properties. The working area expands and shrinks when the barcode image and comment expand or shrink.

Same as all other length properties, the actual value depends on Measurement property. If Measurement is mbxMeasureEnglish, the value is measured in mils(1/1000 inch), otherwise it is in high metric (1/1000 cm).

The default working area under label design mode is 2" by 2". When you set AutolabelSize to FALSE, Barcode ActiveX uses the default size for the working area by setting both LabelHeight and LabelWidth to 2000 mils.

12.23. MaxicodeClass Property

Description

Returns or sets a value that determines the service class for structured carrier message to be encoded in Maxicode symbols generated by Morovia Barcode ActiveX.

Syntax

object.MaxicodeClass[= Number] 

Remarks

The class of service code is a 3-digit number which is defined by the carrier and shipper to indentify the service class.

The default value for this property is 001 .

12.24. MaxicodeMode Property

Description

Returns or sets a value that determines the encoding mode of Maxicode symbols generated by Morovia Barcode ActiveX.

Syntax

 object.MaxicodeMode[= Short] 

Remarks

Maxicode specification defines 5 encoding modes from 2 to 6. Mode 2 and 3 are reserved for domestic and international carrier messages. Mode 4 and mode 5 both encode generic data. Between the two of them, mode 5 offers slightly better data security. Other Maxicode properties, such as MaxicodeClass, MaxicodeCountryCode, are meaningful only under mode 2 and 3. Mode 6 is designated for reader programming purposes.

12.25. MaxicodeCountryCode Property

Description

Returns or sets a value that identifies the country in the structure carrier message encoded in Mode 2 or Mode 3 MaxiCode symbols.

Syntax

object.MaxicodeCountryCode = [Number]

Remarks

The country code is a 3-digit number which represents a country. For a complete list of country codes, see ISO standard 3166.

12.26. MaxicodeZipCode Property

Description

Returns or sets a value for the postal code/zip code used in the structure carrier message under Mode 2 or Mode 3 MaxiCode symbols.

Syntax

object.MaxicodeZipcode = [String] 

Remarks

The MaxiCodeZipCode is the postal code/zip code of the delivery address. Only capital letters and digits are acceptable.

Note: Mode 2 encodes a 9-digit U.S. zip code while Mode 3 encodes a 6-character alpha-numeric postal code. You are not allowed to specify a text with length greater than 9. If MaxiCodeMode is 2 but an alpha-numeric MaxicodeZipCode is specified, the program uses 000000000 as the MaxiCodeZipCode.

12.27. Measurement Property

Description

Returns or sets the measurement unit for all length properties.

Syntax

object.Measurement=[MeasurementEnum] 

Remarks

You can set this property to one of the two values:

Table 12.7. Measurement Unit Options

ConstantValueDescription
mbxMeasureEnglish0All lengths are in mils (1/1000 inch)
mbxMeasureMetrics1All lengths are in 1/1000 cm

Most symbologies use U.S. English measurement unit, which is based on mils (1/1000 inch). Some symbologies are metric oriented, such as Royal Mail and MaxiCode. To produce barcodes as accurate as possible, we recommend that you stick to the measurement unit specified by the standard to avoid float number calculation.

Note

When Measurement changes, all length properties change accordingly so that the barcode sizes remain intact.

12.28. Message Property

Description

Returns or sets a string for the message to be encoded.

Syntax

object.Message[= String] 

Remarks

Not all symbologies are capable of encoding all characters. Some may only encode numeric data. Some impose a limit on the length of the encoded data. If you encode data with invalid characters or length, Barcode ActiveX returns an error.

  • UPC symbologies (UPC-A, UPC-E, EAN-13, EAN-8)

    A UPC symbol may have an optional 2-digit or 5-digit add-on barcode. To create an add-on barcode, separate the main data and the extension data with a vertical bar. For example, the input 1-932111-39-5|55999 produces a Bookland barcode with a 5-digit add-on symbol.

  • GS1 DataBar Symbologies (DataBar, Truncated, Limit, Stacked and Stacked Omnidirectional)

    All GS1 DataBar symbologies excluding DataBar Expanded encode A 14-digit number called GTIN (Global Trade Identification Number). The input must be exactly 13 or 14 digits. AI (01) is part of human readable but should not go into the input.

  • GS1-128 Symbology

    To ensure the human readable format is correct, the AI and field ID must be enclosed with parentheses ( () ). If the data is formatted incorrectly you may end with an error. For example, the following data is valid for UCC/EAN 128 message input:

    (01)12345678901231

    Additional information is also needed to create a shortest possible barcode. Refer to Section 14.12, “UCC/EAN-128” for more details.

  • GS1 DataBar Expanded

    The data encoded by DataBar Expanded follow the exact rules that outlined in the above bullet (See GS1-128 Symbology). AI must be enclosed with parentheses ( () ).

  • Tilde codes

    Tilde code sequence can be used to enter special characters, such as extended ASCII characters and symbology-specific characters if supported. See each Symbology section for details.

12.29. NarrowBarWidth Property

Description

Returns or sets a value for the width of the narrowest module in linear symbologies.

Syntax

object.NarrowBarWidth[= Number] 

Remarks

This property defines the width of the narrowest element in a linear barcode - a.k.a X-dimension. The measurement unit is in either 1/1000 inch or 1/1000 cm depending on the Measurement unit used.

By default the value for this property is 13. The valid range is from 1 to 1000. Industry standards require that the barcodes used in an open system have a X-dimension at least of 10 mils (one-hundredth of inch). If the X-dimension is too small, some scanners may have problems reading the barcode.

This property affects most linear symbologies. Height-modulated postal barcodes, such as POSTNET and Royal Mail barcodes, use fixed pitch thus this property has no effect on these symbologies.

12.30. NarrowToWideRatio Property

Description

Returns or sets the ratio of the wide to narrow bar in a barcode.

Syntax

object.NarrowToWideRatio[= Double] 

Remarks

Some linear symbologies can have two module widths. The width of the wide one is a fixed multiple of the width of the narrow module (NarrowBarWidth). You can choose a value ranging from 2.0 to 3.0 for this ratio.

This property is valid only for Code 39, Code 25, Code 11, Codabar and Interleaved 2 of 5 symbologies. All others ignore this property. We also recommend you set a value between 2.5 to 3.0 so the barcode can be easier to be recognized.

Since the value may impact the readability of the barcode, we highly recommend that you test the barcode readability when you set the value to anything below 2.5.

12.31. PDFAspectRatio Property

Description

Returns or sets a value for the overall height to width ratio of PDF417 barcode generated by Barcode ActiveX.

Syntax

object.PDFAspectRatio[= Double] 

Remarks

The PDFAspectRatio determines the overall shape of the PDF417 symbol and is defined as the overall height to width ratio. Higher values for the Aspect Ratio (greater than 1) produce tall, thin PDF417 bar codes and small values (greater than zero and less than 1) produce short, wide bar codes. A value of 1 produces approximately square bar codes.

The default value for this property is 0.5.

12.32. PDFMaxCols Property

Description

Returns or sets a value for the maximum number of codeword columns allowable in all PDF417 barcodes generated. Since version 3.4, this property is also used to specify the number of symbol per row in GS1 DataBar Expanded symbology.

Syntax

object.PDFMaxCols[= Double] 

Remarks

The PDFMaxCols and the PDFMaxRows properties allow you to set the target number of columns and rows.

The PDFMaxCols property specifies the maximum number of codeword columns in a PDF symbol. It can be set to a value ranging from 1 to 30.

Since version 3.4, GS1 DataBar Expanded is supported in Barcode ActiveX Professional and Barcode DLL product line. DataBar Expanded can be mutliple rows, with each row holding even number of symbol characters. This property is used to specify the number of symbols per row in DataBar symbology. This number must be between 2 and 22 otherwise 22 is used. Because DataBar Expanded can have 22 symbols at the most. Setting to 22 or 0 makes the resulted barcode one row only. When used in DataBar Expanded symbology, the number must be even otherwise it is rounded to the closet even integer.

See Also

Section 12.33, “PDFMaxRows Property”

12.33. PDFMaxRows Property

Description

Returns or sets a value for the maximum number of codeword rows allowable in all PDF417 bar code symbols produced by Morovia Barcode ActiveX.

Syntax

object.PDFMaxRows[= Number] 

Remarks

The PDFMaxCols and the PDFMaxRows properties allow you to set the target number of columns and rows. The default value for PDFMaxRows is 0, meaning that program automatically picks the number of rows. The valid range for this property is 3 to 90.

See Also

Section 12.32, “PDFMaxCols Property”

12.34. PDFModuleHeight Property

Description

Returns or sets a value for the height of the modules in the PDF417 barcode generated.

Syntax

object.PDFModuleHeight[= Number] 

Remarks

The recommended value for PDFModuleHeight is approximately three times the value of PDFModuleWidth. You can set this property to any values greater than 10 mils.

The valid range for PDFModuleHeight is from 1 to 100. The default value is 30.

See Also

Section 12.35, “PDFModuleWidth Property”

12.35. PDFModuleWidth Property

Description

Returns or sets a value for the width of the modules in the PDF417 barcodes generated.

Syntax

object.PDFModuleWidth[= Number] 

Remarks

The recommended value for PDFModuleWidth is between 10 and 30 mils. To achieve the best read rate, we recommend that you set a value which is integral times of the pixel width on the target device (the width of a pixel on a computer display is 10.42 mils and the one on a laser printer is 3.33 mils).

The valid range for this property is between 1 and 100. The default value is 13.

See Also

Section 12.34, “PDFModuleHeight Property”

12.36. PDFSecurityLevel Property

Description

Returns or sets a value for security level used in all PDF417 barcodes generated.

Syntax

object.PDFSecurityLevel[= Number] 

Remarks

The PDFSecurityLevel property allows you to select a PDF417 error correction level from 0 to 8 (or 9 for automatic). Each higher security level up to 8 adds additional overhead to a PDF417 symbol thereby requires large symbol space.

The default value for this property is 9 (automatic).

12.37. PDFTruncatedSymbol Property

Description

Returns or sets a value that determines whether to generate the truncated version of all PDF417 bar codes generated by the Barcode ActiveX.

Syntax

object.PDFTruncatedSymbol[= Boolean] 

Remarks

You can produce a truncated version of PDF417 barcode by setting PDFTruncatedSymbol to TRUE. A truncated PDF417 symbol reduces the stop pattern to a single termination bar. Truncated symbols should be used only in a clean and controled environment.

The default value for this property is FALSE.

12.38.  Picture Property

Description

Readonly property. Returns a snapshot of the drawing in Windows Enhanced Metafile Format (EMF).

Syntax

object.Picture

Remarks

The Picture property provides a convenient method to retrieve the drawing without first saving it to disk. The picture object contains an enhanced metafile handle which can be passed to clipboard or played on a device.

Note after version 3.2, drawing units are measured from the default printer. If you print to a low-resolution printer, set the target printer as the default before retrieving the EMF handle.

12.39. QuietZones Property

Description

Returns or sets a value that determines whether to include quiet zones on the barcodes generated.

Syntax

object.QuietZones[= Boolean] 

Remarks

In linear barcodes, quiet zone is defined as a clear space that precedes the start character of a barcode symbol and follows the stop character. In two-dimensional barcodes quiet zones are clear area around the barcode. The space is required to help scanner determine where the barcode starts and stops.

The width of space added is 10 times the NarrowBarWidth value for all linear barcodes, 2 times PDFModuleWidth value for PDF417 barcodes, 2 times DataMatrixModuleSize value for DataMatrix barcodes and 1 element width for MaxiCode barcodes. Setting this property substantially increase the barcode length for linear symbologies.

You can also use symbol margins to create effective quiet zones. By default Barcode ActiveX set the symbol margins to 100 mils at 4 directions. When this is the case, you may safely set this property to FALSE to better align the comment and human readable text.

12.40. RasterImageResolution Property

Description

RasterImageResolution - returns or sets a value that corresponds to the resolution (in pixels per inch) of the target device when export barcode images to a raster graphic file format (JPEG, GIF, PNG, TIF and BMP).

Syntax

object.RasterImageResolution[= Number] 

Remarks

When you export the barcode image into a raster graphics file format such as JPG, GIF and PNG, you are converting the drawing commands (device independent) to an array of pixels which are device dependent. The size of a pixel varies based on the device and usually is measured by dot per inch (dpi). A laser printer usually has a high resolution of 300 dpi while the screen has a low resolution of 96 dpi. As a result, an image may have different physical size when displayed on the screen than printed. The greater the resolution is, the bigger the file size and the accurate of the details. We suggest you set this property to the value which matches your printer.

The default value for this property is 300.

See Also

Section 12.52, “ExportImage Method”

12.41. Rotation Property

Description

Returns or sets a value indicating how to rotate the working area.

Syntax

object.Rotation=[RotationEnum] 

Remarks

This property controls how the working area is rotated. Valid rotation choices are:

Table 12.8. Rotation Options

ConstantValueDescription
mbxRTZeroDegree0No rotation
mbxRTAntiClockwise_901Rotate at 90 degrees angle counterclockwise
mbxRTAntiClockwise_1802Rotate at 180 degrees angle counterclockwise(upside down)
mbxRTAntiClockwise_2703Rotate at 270 degrees angle counterclockwise

12.42. ShowCheckDigit Property

Description

ShowCheckDigit - Determines whether the checksum characters will be shown on the human readable portion. This option is effective to selected symbologies only.

Syntax

object.ShowCheckDigit[= Boolean] 

Remarks

Different symbologies have different rules regarding check digit. For some symbologies, check digit is part of the data and should always be included in the human readable text. Some symbologies allow optional check digit. Some symbologies require check character not be displayed at all.

  • Check digit is part of data and is always displayed.

    This category includes UPC-A, UPC-E, EAN-13, EAN-8, Bookland, and UCC/EAN-128. This property has no effect on these symbologies.

  • Check digit is required, but not treated as part of data and is never included in the human readable text.

    This category includes Code 128, Telepen and Telepen Numeric.

  • Check digit is required, and can be optinally included into the human readable text.

    This category includes Code 93, Code 11, POSTNET, PLANET and MSI/Plessey.

  • Check digit is optional, and can be optionally included in the human readable text.

    This category includes Code 39, Code 39 Full ASCII, HIBC.

In version 3.4, there are some noteable changes:

  • Previously, HIBC barcodes may turn off its check digit in the human readable display (although the check digit always appear in the barcode). After 3.4, the check digit is always included in the human readable text, as required by the standard.

  • Before 3.4, whether a UCC/EAN-128 check digit is calculated depends on UccEanOptionalCheckDigit. After version 3.4, the check digit is always included in the human readable text.

See Also

Section 12.44, “ShowHRText Property”

Section 12.10, “ Code25OptionalCheckDigit Property ”

Section 12.11, “Code39OptionalCheckDigit Property”

Section 12.21, “I2of5OptionalCheckDigit Property”

12.43. ShowComment Property

Description

Returns or sets a value that determines whether the control displays the comment portion.

Syntax

object.ShowComment[= Boolean] 

Remarks

Toggle this property to turn on or turn off the display of the comment portion. Note that if this property is FALSE, comment margin properties will not be included during the position calculation of other components, such as working area, bar code image etc. If you want to have these margins participate the calculation and do not want to see the comment, set Comment property to an empty string instead.

12.44. ShowHRText Property

Description

Returns or sets a value that determines whether the control displays the human readable portion.

Syntax

object.ShowHRText[= Boolean] 

Remarks

Toggle this property to turn on or turn off the display of the human readable text.

Two dimensional barcodes do not have the concept of human readable. Consequently this property has no effect on 2D barcodes.

Per standard, UPC-A, UPC-E, EAN-13, EAN-8 barcodes and their supplements should always have the human readable as an integrated part of the image. In versions prior to 3.2, you can not produce those barcodes without visible human readable, even you set ShowHRText to FALSE. This behavior has changed since version 3.2. Unless you have absolute reason to turn it off, you should set ShowHRText to TRUE when creating these types of barcodes.

Note

The width of human readable text portion never exceeds the barcode length. If the barcode length is too small, the text will wrap into multiple lines. If this is not desired, reduce the font size, or place the human readable text into comment and adjust comment margin properties to increase the width of comment box so that the text stays in one line.

12.45. Symbology Property

Description

Returns or sets a value indicating the type of the bar code format (symbology) to be generated by the ActiveX control.

Syntax

object.Symbology[= SymbologyEnum] 

Remarks

The Barcode ActiveX currently supports the following symbologies:

Table 12.9. Symbology Options

ConstantValueDescription
mbxCode390(default) Code 39 (43 character set)
mbxCode39_Full_ASCII1Code 39 Full ASCII
mbxCode39_HIBC2Code 39 Mod 43 (Health Industry Bar Code)
mbxCodaBar3Codabar
mbxCode934Code 93
mbxCode1285Code 128
mbxUCC_EAN_1286UCC/EAN 128
mbxInterleaved_2of57Interleaved 2 of 5 (ITF25)
mbxUPC_A8UPC-A
mbxUPC_E9UPC-E
mbxEAN_1310EAN/JAN-13
mbxEAN_811EAN/JAN-8
mbxBookland12Bookland
mbxTelepen13Telepen
mbxTelepenNumeric14Telepen Numeric (double density)
mbxPostnet20PostNET (barcode used by USPS)
mbxPlanet21Planet (used by USPS for package tracking)
mbxRoyalMail22Royal Mail (U.K. Postal)
mbxMSI_Plessey30MSI/Plessey
mbxCode2531Code 25
mbxCode1132Code 11
mbxCode1132Code 11
mbxDataBar33DataBar
mbxDataBarTruncated34DataBar Truncated
mbxDataBarStacked35DataBar Stacked
mbxDataBarStackedOmni36DataBar Stacked Omnidirectional
mbxDataBarLimited37DataBar Limited
mbxDataBarExpanded38DataBar Expanded
mbxPDF41740PDF 417 (2D symbology)
mbxDataMatrix41DataMatrix (2D symbology)
mbxMaxiCode42MaxiCode (2D symbology)

Some symbologies only encode certain limited set of characters, such as digits. Some symbologies impose limit of the data length; some require checksum characters. If you are not familiar with the symbologies you are working on, refer to Chapter 14, Barcode Technologies to get some hands-on information.

Barcode ActiveX lite version does not support creating two dimensional barcodes, such as PDF417, Data matrix and MaxiCode. Error will be returned if you set Symbology with a value that it does not support.

12.46.  SymbolMarginTop, SymbolMarginBottom, SymbolMarginLeft, SymbolMarginRight Properties

Description

These four properties control the margins around the symbol boundary (including barcode, human readable and comment).

Syntax

SymbolMarginTop[= Number]
SymbolMarginBottom[= Number]
SymbolMarginLeft[= Number]
SymbolMarginRight[= Number]

Remarks

These four parameters control the margins around the symbol (barcode, human readable and comment).

12.47. TexAlignment Property

Description

Returns or sets a value indicating how the human readable text is aligned.

Syntax

TexAlignment[= AlignmentEnum]

Remarks

This property controls how the text in the human readable portion is aligned. Valid alignment choices are:

Table 12.10. TexAlignment Options

ConstantValueDescription
mbxAlignLeft0Left alignment (default). Align the text with left edge of the comment box.
mbxAlignRight1Right alignment. Align the text with the right edge of the comment box.
mbxAlignCenter2Center alignment. Align the text with the center of the comment box
mbxAlignJustify3Justify alignment. Align the text to both edge of the comment box.

Because of the unique character arrangement in UPC/EAN symbologies, this property does not apply on those symbologies: UPC-A, UPC-E, EAN-13 and EAN-8.

The barcodes below illustrate the effects of TexAlignment:

Note

When our first Barcode component product was released, the property was misspelled as TexAlignment instead of the correct spelling TextAlignment. For compatibility reasons we keep using the misspelled word as the property name. Check the spelling when you find that your application did not achieve the desired result.

See Also

Section 12.20, “Font Property”

Section 12.44, “ShowHRText Property”

12.48. TextOnTop Property

Description

Returns or sets a value that determines whether the human readable text is placed above the barcode image or below the image.

Syntax

object.TextOnTop[= Boolean]

Remarks

The default value for TextOnTop is FALSE which places the human readable text below the barcode. To place the human readable text above the barcode, set TextOnTop to TRUE.

Two-dimensional symbologies (PDF417, Data Matrix and MaxiCode) do not support human readable text. This property has no effects when the current symbology is PDF417, Data Matrix or MaxiCode.

See Also

Section 12.20, “Font Property”

Section 12.44, “ShowHRText Property”

Section 12.47, “TexAlignment Property”

12.49. UccEanOptionalCheckDigit Property

Description

Deprecated since version 3.4.

Syntax

object.UccEanOptionalCheckDigit

Remarks

Before version 3.4, this

This property kicks in only when all the following conditions are met: (1) the current symbology is set to UCC_EAN_128. (2) the data element contains an AI of 00 (SSCC-18) or 01(SCC-14). (3) the data length is 1ess than the required. The check digit is calculated based on Mod 10 algorithm and appended to the end of the data part. The check digit also appears in the human readable text.

For example, when the property UCC_EAN_128 is set to TRUE, the data (01)3001234567890 becomes (01)30012345678906 where the last digit of 6 is the calculated mod10 check digit.

12.50. ZoomRatio Property

Description

Returns or sets the value that determines the actual display size of the control.

Syntax

object.ZoomRatio[= Double] 

Remarks

When the AutoSize is FALSE, the container controls the size of the display area. The Barcode ActiveX displays itself to the full extent in the display area prescribed by the container while keeping the aspect ratio. The user can not set ZoomRatio under this mode; instead the user changes the property by dragging the tracking box using the mouse pointer.When the AutoSize property is set to TRUE, the Barcode ActiveX decides the size of the display area. You can change the size of the display area by modifying the natural size, or the ZoomRatio. To make sure that barcode created has a high quality, do not set ZoomRatio to any values other than 1 at the print time. To modify the barcode size it is highly recommended to do so through length properties, such as NarrowBarWidth, BarHeight, and PDF417ModuleHeight etc.

12.51. About Method

Description

Display the About Dialog.

Syntax

object.About

Remarks

The About dialog displays the version information. It also displays the license information used to create the barcode object.

12.52. ExportImage Method

Description

Exports the image to a graphics file with the specified format. This allows other programs to use the barcode images generated.

Syntax

Object.ExportImage filename|stream, fileformat

Remarks

Exports the image into the file specified by the filename in a standard format. Barcode ActiveX supports the export to the following graphic formats:

ConstantValueDescription
mbxFormatBMP0Windows bitmap
mbxFormatJPG1JPEG
mbxFormatGIF2GIF
mbxFormatTIF3TIFF
mbxFormatPNG5PNG
mbxFormatEMF6EMF (Windows Enhanced MetaFile)
mbxFormatWMF7WMF (Windows MetaFile)

Use ExportImage to save the barcode image to a disk file or a Streamobject, with the specified graphic format. If the file already exists, the method overwrites the file.

When Barcode ActiveX exports to EMF format, the resolution of the default printer is used as the basis to create the barcode. If you use the EMF handle to print to a low resolution printer, set this printer as default before calling ExportImage.

When Barcode ActiveX exports to WMF format, a high resolution of 1440 dpi is assumed. A high resolution printer is needed to replay the WMF handle.

All other file formats are raster image format. The property RasterImageResoluton determines the resolution to use during the rasterization. PNG or GIF are preferred formats because they are lossless and compressed well for barcode images.

Instead of the file name, you can also pass a Stream object to the first parameter to transfer the image data into memory. The method has been tested with Microsoft ADODB.Stream object. The IIS barcoding sample uses this approach to retrieve the image data from the Barcode ActiveX and sends to the browser.

Note

The WMF file format does not contain frame size information. To find out the exact size, retrieve LabelHeight and LabelWidth from the object. The bitmap rendering process utilizes printer drivers. To avoid rounding errors between the drawing units (target resolution) and the device units (for text measurement), we recommend that you have the printer driver installed on the computer that creates the barcode image. For example, if you create bitmap images targeting a thermal printer (203 dpi), you should install such a printer driver on the computer you are working. During the ExportImage process, the printer driver is consulted to make sure that the bitmap created reflects the actual print out. You do not need to connect the printer to the computer. The barcode quality is ensured when RasterImageResolution is set to a value compatible with screen or an installed printer device.

Note

The behavior of this method changed in version 3.6.

In versions before 3.6, the Save method overwrite the file if it exists. After 3.6, an existing file is overwritten only when all conditions below are true:

  • None of the following attribute bits is set: read-only, hidden and system.

  • The extension of the file must be one of the following: bmp, jpg, jpeg, gif, tif, tiff, png, emf or wmf.

If any of the conditions is not met, the method returns an error.

However, if the path specified does not exist, a new file will be created, and the rules on the attributes and extensions do not apply.

See Also

Section 12.40, “RasterImageResolution Property”

Chapter 6, Working with Low Resolution Devices

12.53. Load Method

Description

Load the Barcoce ActiveX object from a file, in binary or XML format.

Syntax

object.Load Destination, PersistFormat 
  • Destination

    A Variant that represents the complete path name of the file where the object is to be saved.

  • PersistFormat

    Optional. A PersistFormatEnum value that specifies the format in which the object is to be saved (XML or Bianry). The default value is mbxPersistBinary.

Remarks

The Load method loads the property data and draws the barcode image based on the data loaded. The PersistFormat can be one of these values:

Table 12.11. PersistFormat Options (Load method)

ConstantValueDescription
mbxPersistBinary0Binary Format
mbxPersistXML1XML Format

12.54. Save Method

Description

Saves the Barcoce ActiveX object in a file, in binary or XML format.

Syntax

object.Save Destination, PersistFormat 
  • Destination

    A Variant that represents the complete path name of the file where the object is to be saved.

  • PersistFormat

    A PersistFormatEnum value that specifies the format in which the object is to be saved (XML or Bianry). The default value is mbxPersistBinary.

Remarks

The Save method saves the property data into a disk file or a Streamobject in binary or XML format. The PersistFormat can be one of these values:

Table 12.12. PersistFormat Options (Save method)

ConstantValueDescription
mbxPersistBinary0Binary Format
mbxPersistXML1XML Format

If the file already exist, the method overwrites the file.

Note

The behavior of this method changed in version 3.6.

In versions before 3.6, the Save method overwrites the file if it exists. After 3.6, an existing file is overwritten only when all conditions below are true:

  • None of the following attribute bits is set: read-only, hidden and system.

  • The extension of the file must be one of the following: bax, bax3, mbx or xml.

If any of the conditions is not met, the method returns an error.

However, if the path specified does not exist, a new file will be created, and the rules on the attributes and extensions do not apply.

See Also

Section 12.53, “Load Method”

12.55. Refresh Method

Description

Refresh - redraws the current barcode image.

Syntax

object.Refresh

Remarks

This method is provided as a means to force the ActiveX control redraw itself. The control redraws itself whenever it determines that a redraw is needed.