Barcode Control

Documentation home

Description. 1

Properties 1

Barcode Control Properties 1

Barcode Tab. 2

Barcode Image. 3

Barcode Text 4

Texts Tab. 4

Codabar Properties 4

Code 39 Properties 4

Datamatrix Properties 5

Postnet Properties 5

Interleaved Properties 6

EAN-8 Properties 7

EAN-13 Properties 7

EAN-128 Properties 8

UPC-A Properties 8

UPC-E Properties 9

Royal Mail Customer Barcode Properties 9

USPS Intelligent Mail Properties 10

PDF417 Properties 10

Preview of supported barcodes 11

Right Click Menu Actions 12

See also: Designing Print Pages, Controls, Layouts

Description

A Barcode control is used to place a barcode on a page. It can be used for web pages or for printed pages (see Designing Print Pages). A large number of different barcode types are supported – see the Preview of supported barcodes.

Properties

See also control common properties and local/inherited control properties.

Barcode Control Properties

Barcode Tab

Property	Description	Name^1	Type^1	Get^1	Set^1
Barcode type	Specifies the type/style of the barcode. The type is a static integer value that can be accessed through the BarcodeControl API. e.g BarcodeControl.CODABAR	type	Integer	Yes	Yes
Barcode height	Specifies the height of the barcode	barcodeHeight	Character	Yes	Yes
Barcode module width	Specifies the width of the barcode	moduleWidth	Character	Yes	Yes
Quiet zone enabled	Indicates whether to add white space around the barcode. This is specified by the Quiet Zone and Quiet Zone Height (where applicable) properties.	quietZoneEnabled	Boolean	Yes	Yes
Quiet zone	Specifies the width of the quiet zone either side of the barcode in mm	quietZone	Character	Yes	Yes
Message position	Specifies the position of the barcode text. This can be configured as either: top - positions the text at the top of the barcode bottom - positions the text at the bottom of the barcode none - no text is displayed	messagePosition	Character	Yes	Yes

Barcode Image

Property	Description	Name^1	Type^1	Get^1	Set^1
Resolution	Specifies the DPI resolution of the barcode	imageResolution	Character	Yes	Yes
Grayscaled	Indicates whether the barcode is rendered as gray scaled and anti-aliasing.	imageGrayScaled	Boolean	Yes	Yes
Orientation	Specifies the how the image is rendered on the screen. The value is specified in degrees. Typically the value should be set to 0, 90, 180 or 270.	Orientation	Integer	Yes	Yes

Barcode Text

Property	Description	Name^1	Type^1	Get^1	Set^1
Barcode Text	Properties for the barcode text. See text properties.	message	Character	Yes	Yes
Font Name	Specifies the font name for the human readable part of the barcode	fontName	Character	Yes	Yes
Font size	Specifies the font size for the human readable part of the barcode	fontSize	Integer	Yes	Yes
Barcode Text	Configure pattern text for the human readable part of the barcode	Pattern	Character	Yes	Yes

Texts Tab

Property	Description	Name^1	Type^1	Get^1	Set^1	Get/Set Values^1
Alternative Text	The alternative text for the barcode (required for accessibility). <barcode-name> barcode is returned if a value is not entered; For example: Codabar barcode	alternativeText	Character	Yes	Yes
Mouse Over Text	Text displayed when the mouse is moved over the barcode.	mouseOverText	Character	Yes	Yes

Codabar Properties

Property	Description	Name^1	Type^1	Get^1	Set^1
Wide factor	Specifies the factor by which the wide bars are broader than the narrow bars	barcodeWideFactor	Character	Yes	Yes

Code 39 Properties

Property	Description	Name^1	Type^1	Get^1	Set^1
Checksum	Specifies the checksum mode. The value can be set as: auto - chooses the barcode's default checksum behaviour add - adds the necessary checksum to the message to be encoded check - requires the check character to be present in the message. Ignore - doesn't check nor add a checksum	checksum	Character	Yes	Yes
Display checksum	Enables or disables the use of the checksum in the human-readable message	displayChecksum	Boolean	Yes	Yes
Wide factor	Specifies the effective width of a bar with a given logical width	barcodeWideFactor	Character	Yes	Yes
Interchar gap	Specifies the width between encoded characters.	interCharGap	Character	Yes	Yes
Display Start Stop Character	Indicates whether the start and stop character will be displayed as part of the human-readable message	displayStartStop	Boolean	Yes	Yes

Datamatrix Properties

Property	Description	Name^1	Type^1	Get^1	Set^1
Shape	Can be set to either “square” or “rectangle”	dataMatrixShape	Character	Yes	Yes

Postnet Properties

Property	Description	Name^1	Type^1	Get^1	Set^1
Checksum	Specifies the checksum mode. The value can be set as: auto - chooses the barcode's default checksum behaviour add - adds the necessary checksum to the message to be encoded check - requires the check character to be present in the message. Ignore - doesn't check nor add a checksum	checksum	Character	Yes	Yes
Display checksum	Enables or disables the use of the checksum in the human-readable message	displayChecksum	Boolean	Yes	Yes
Interchar gap	Specifies the width between encoded characters	interCharGap	Character	Yes	Yes
Baseline position	Specifies the position of the barcode baseline. This can be set to either: top – top of the barcode bottom – bottom of the barcode	baselinePosition	Character	Yes	Yes
Short bar height	Specifies the height of the short bar	shortBarHeight	Character	Yes	Yes
Quiet zone vertical	Specifies the vertical quiet zone	quietZoneVertical	Character	Yes	Yes

Interleaved Properties

Property	Description	Name^1	Type^1	Get^1	Set^1
Checksum	Specifies the checksum mode. The value can be set as: auto - chooses the barcode's default checksum behaviour add - adds the necessary checksum to the message to be encoded check - requires the check character to be present in the message. Ignore - doesn't check nor add a checksum	checksum	Character	Yes	Yes
Display checksum	Enables or disables the use of the checksum in the human-readable message	displayChecksum	Boolean	Yes	Yes
Wide factor	Specifies the effective width of a bar with a given logical width.	barcodeWideFactor	Character	Yes	Yes
Interchar gap	Specifies the width between encoded characters.	interCharGap	Character	Yes	Yes

EAN-8 Properties

Property	Description	Name^1	Type^1	Get^1	Set^1
Checksum	Specifies the checksum mode. The value can be set as: auto - chooses the barcode's default checksum behaviour add - adds the necessary checksum to the message to be encoded check - requires the check character to be present in the message. Ignore - doesn't check nor add a checksum	checksum	Character	Yes	Yes

EAN-13 Properties

Property	Description	Name^1	Type^1	Get^1	Set^1
Checksum	Specifies the checksum mode. The value can be set as: auto - chooses the barcode's default checksum behaviour add - adds the necessary checksum to the message to be encoded check - requires the check character to be present in the message. Ignore - doesn't check nor add a checksum	checksum	Character	Yes	Yes

EAN-128 Properties

Property	Description	Name^1	Type^1	Get^1	Set^1
Checksum	Specifies the checksum mode. The value can be set as: auto - chooses the barcode's default checksum behaviour add - adds the necessary checksum to the message to be encoded check - requires the check character to be present in the message. Ignore - doesn't check nor add a checksum	checksum	Character	Yes	Yes
Template	Specifies the message template with the fields for the EAN message	template	Character	Yes	Yes
Omit brackets	Indicates whether to omit the brackets from the human readable part of the barcode	omitBrackets	Boolean	Yes	Yes

UPC-A Properties

Property	Description	Name^1	Type^1	Get^1	Set^1
Checksum	Specifies the checksum mode. The value can be set as: auto - chooses the barcode's default checksum behaviour add - adds the necessary checksum to the message to be encoded check - requires the check character to be present in the message. Ignore - doesn't check nor add a checksum	checksum	Character	Yes	Yes

UPC-E Properties

Property	Description	Name^1	Type^1	Get^1	Set^1
Checksum	Specifies the checksum mode. The value can be set as: auto - chooses the barcode's default checksum behaviour add - adds the necessary checksum to the message to be encoded check - requires the check character to be present in the message. Ignore - doesn't check nor add a checksum	checksum	Character	Yes	Yes

Royal Mail Customer Barcode Properties

Property	Description	Name^1	Type^1	Get^1	Set^1
Checksum	Specifies the checksum mode. The value can be set as: auto - chooses the barcode's default checksum behaviour add - adds the necessary checksum to the message to be encoded check - requires the check character to be present in the message. Ignore - doesn't check nor add a checksum	checksum	Character	Yes	Yes
Interchar gap	Specifies the width between encoded characters.	interCharGap	Character	Yes	Yes
Track height	Specifies the height of the track	trackheight	Character	Yes	Yes
Ascender height	Specifies the height of the ascender/descender.	ascenderHeight	Character	Yes	Yes

USPS Intelligent Mail Properties

Property	Description	Name^1	Type^1	Get^1	Set^1
Checksum	Specifies the checksum mode. The value can be set as: auto - chooses the barcode's default checksum behaviour add - adds the necessary checksum to the message to be encoded check - requires the check character to be present in the message. Ignore - doesn't check nor add a checksum	checksum	Character	Yes	Yes
Interchar gap	Specifies the width between encoded characters.	interCharGap	Character	Yes	Yes
Track height	Specifies the height of the track	trackheight	Character	Yes	Yes
Ascender height	Specifies the height of the ascender/descender.	ascenderHeight	Character	Yes	Yes
Quiet zone vertical	Specifies the vertical quiet zone	quietZoneVertical	Character	Yes	Yes

PDF417 Properties

Property	Description	Name^1	Type^1	Get^1	Set^1
Max rows	Specifies the maximum number of rows	maxRows	Integer	Yes	Yes
Min rows	Specifies the minimum number of rows	minRows	Integer	Yes	Yes
Max columns	Specifies the maximum number of columns	maxCols	Integer	Yes	Yes
Min columns	Specifies the minimum number of columns	minCols	Integer	Yes	Yes
Width to height ratio	Specifies the ratio of the barcode width to the height	widthToHeightRatio	Character	Yes	Yes
Error correction level	Specifies the error correction level for the barcode.	errorCorrectionLevel	Integer	Yes	Yes

¹ See accessing control properties from scripts

Examples of setting properties via API based language:

//set the barcode text

controls.MyBarcode.message.text = "123456788";

Preview of supported barcodes

Barcode	PNG Image
Codabar
Code 128
Code 39
Datamatrix (rectangle)
Datamatirx (square)
Postnet
Interleaved
EAN-8
EAN-13
EAN-128
UPC-A
UPC-E
Royal Mail Customer Barcode
USPS Intelligent Mail
PDF417

Right Click Menu Actions

Click here for right-click menu actions available to all controls.

There are no specific right click actions for this control.