Interleaved 2 of 5 and ITF-14 Script Methods

The following script methods are specific to this barcode symbology. Additionally, you can use the Common Script Methods for Barcodes.

Tip: If using these script methods in a business rule, select the Rhino script engine.

Tip: Script methods with names beginning with get or is retrieve the current value for a property. Script methods with names beginning with set configure a value for the property.

Methods	Description	Values
getBarHeight() setBarHeight(long)	The height of the bars in the barcode.	Thousandths of an inch (mil)
getCheckDigit() setCheckDigit(String) getUserGeneratedCheckDigit()	Add an optional check digit to the barcode. The listed check digits are optional forms of the selected symbology. Special purpose check digits can be added to the barcode using the Formula data source. Note: Specifying a value other than None decreases Max Chars to allow a character for the check digit, which is not counted toward the value of Max Chars. Note: When a form that includes a check digit is used, the Data Provider Person or process that enters data into a form or other data entry view for a label that was configured by a Designer. A user acting as a Data Provider requires the DOCUMENT_PRINTER role or equivalent permissions. is not alerted if the check digit fails.	None Mod 10 User Mod 10 (Interleaved 2 of 5 only)
getHumanReadable() setHumanReadable(String)	Whether a text representation of the barcode is printed. The human readable text can be positioned anywhere on the label (free floating).	none freeFloating
	Bearer bars are used to reduce the chance that a non-fixed length symbol is incorrectly read.	None Top/Bottom Rectangle
getXdim() setXdim(float)	The X-dimension or width of the narrowest bar in the barcode. The range of values available depends on the Document DPI of the label template. For example, a label template with a Document DPI of 203 has Line X-Dim values in increments of 4.9 mil (1000 mil / 203 dpi).	Thousandths of an inch (mil)
getRatio() setRatio(String)	The ratio of the wide bar to the narrow bar. The ratio can be used to create intermediate sizes between different X-dimensions. For Example For Ratio 3.0:1, the wide bars are three times the size of the narrow bars.	2.0:1 2.1:1 2.2:1 2.25:1 2.3:1 2.4:1 2.5:1 2.6:1 2.7:1 2.8:1 2.9:1 3.0:1

Methods

Description

Values

getBarHeight()

setBarHeight(long)

The height of the bars in the barcode.

Thousandths of an inch (mil)

getCheckDigit()

setCheckDigit(String)

getUserGeneratedCheckDigit()

Add an optional check digit to the barcode.

The listed check digits are optional forms of the selected symbology.

Special purpose check digits can be added to the barcode using the Formula data source.

Note: Specifying a value other than None decreases Max Chars to allow a character for the check digit, which is not counted toward the value of Max Chars.

Note: When a form that includes a check digit is used, the Data Provider Person or process that enters data into a form or other data entry view for a label that was configured by a Designer. A user acting as a Data Provider requires the DOCUMENT_PRINTER role or equivalent permissions. is not alerted if the check digit fails.

None

Mod 10

User Mod 10 (Interleaved 2 of 5 only)

getHumanReadable()

setHumanReadable(String)

Whether a text representation of the barcode is printed.

The human readable text can be positioned anywhere on the label (free floating).

none

freeFloating

Bearer bars are used to reduce the chance that a non-fixed length symbol is incorrectly read.

None

Top/Bottom

Rectangle

getXdim()

setXdim(float)

The X-dimension or width of the narrowest bar in the barcode. The range of values available depends on the Document DPI of the label template. For example, a label template with a Document DPI of 203 has Line X-Dim values in increments of 4.9 mil (1000 mil / 203 dpi).

Thousandths of an inch (mil)

getRatio()

setRatio(String)

The ratio of the wide bar to the narrow bar. The ratio can be used to create intermediate sizes between different X-dimensions.

For Example

For Ratio 3.0:1, the wide bars are three times the size of the narrow bars.

2.0:1

2.1:1

2.2:1

2.25:1

2.3:1

2.4:1

2.5:1

2.6:1

2.7:1

2.8:1

2.9:1

3.0:1

Additional Methods

The following methods do not have corresponding controls for barcode objects in the Loftware Enterprise SP user interface.

Methods

Description

Values

getHrzBearerWidth()

setHrzBearerWidth(double)

getVrtBearerWidth()

setVrtBearerWidth(double)