BarcodeParameters

BarcodeParameters

Barcode generation parameters.

Constructor

new BarcodeParameters()

Source:

Methods

getAustralianPost()

AustralianPost barcode parameters.
Source:

getAztec()

Aztec parameters.
Source:

getBarColor()

Bars color.
Returns:
Type Description
value of Bar color Default value: #000000
Source:

getBarHeight()

Height of 1D barcodes' bars in Unit value.
Ignored if AutoSizeMode property is set to AutoSizeMode.NEAREST or AutoSizeMode.INTERPOLATION.
Source:
Throws:
BarcodeException

getBarWidthReduction()

Get bars reduction value that is used to compensate ink spread while printing.
Returns:
Type Description
Unit value of BarWidthReduction
Source:

getChecksumAlwaysShow()

Always display checksum digit in the human readable text for Code128 and GS1Code128 barcodes.
Source:

getCodabar()

Codabar parameters.
Source:

getCodablock()

Codablock parameters.
Source:

getCode128()

Code128 parameters.

Source:

getCode16K()

Code16K parameters.
Source:

getCodeTextParameters()

Codetext parameters.
Source:

getCoupon()

Coupon parameters. Used for UpcaGs1DatabarCoupon, UpcaGs1Code128Coupon.
Source:

getDataBar()

Databar parameters.
Source:

getDataMatrix()

DataMatrix parameters.
Source:

getDotCode()

DotCode parameters.
Source:

getEnableEscape()

Indicates whether explains the character "\" as an escape character in CodeText property. Used for Pdf417, DataMatrix, Code128 only
If the EnableEscape is true, "\" will be explained as a special escape character. Otherwise, "\" acts as normal characters.
Aspose.BarCode supports inputing decimal ascii code and mnemonic for ASCII control-code characters. For example, \013 and \\CR stands for CR.
Source:

getFilledBars()

Gets a value indicating whether bars filled.
Only for 1D barcodes.
Default value: true.
Source:

getGS1CompositeBar()

GS1 Composite Bar parameters.

This sample shows how to create and save a GS1 Composite Bar image.
Note that 1D codetext and 2D codetext are separated by symbol '/'
Returns:
Type Description
GS1CompositeBarParameters GS1 Composite Bar parameters.
Source:
Example
let codetext = "(01)03212345678906/(21)A1B2C3D4E5F6G7H8";
let generator = new BarcodeGenerator(EncodeTypes.GS_1_COMPOSITE_BAR, codetext);

generator.getParameters().getBarcode().getGS1CompositeBar().setLinearComponentType(EncodeTypes.GS_1_CODE_128);
generator.getParameters().getBarcode().getGS1CompositeBar().setTwoDComponentType(TwoDComponentType.CC_A);

// Aspect ratio of 2D component
generator.getParameters().getBarcode().getPdf417().setAspectRatio(3);

// X-Dimension of 1D and 2D components
generator.getParameters().getBarcode().getXDimension().setPixels(3);
///
// Height of 1D component
generator.getParameters().getBarcode().getBarHeight().setPixels(100);
///
generator.save("test.png", BarcodeImageFormat.PNG);

getHanXin()

HanXin parameters.
Source:

getITF()

ITF parameters.
Source:

getMaxiCode()

MaxiCode parameters.
Source:

getPadding()

Barcode paddings.
Default value: 5pt 5pt 5pt 5pt.
Source:

getPatchCode()

PatchCode parameters.
Source:

getPdf417()

PDF417 parameters.
Source:

getPostal()

Postal parameters. Used for Postnet, Planet.
Source:

getQR()

QR parameters.
Source:

getSupplement()

Supplement parameters. Used for Interleaved2of5, Standard2of5, EAN13, EAN8, UPCA, UPCE, ISBN, ISSN, ISMN.
Source:

getWideNarrowRatio()

Wide bars to Narrow bars ratio
. Default value: 3, that is, wide bars are 3 times as wide as narrow bars
. Used for ITF, PZN, PharmaCode, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, IATA2of5, VIN, DeutschePost, OPC, Code32, DataLogic2of5, PatchCode, Code39Extended, Code39Standard
The WideNarrowRatio parameter value is less than or equal to 0.
Source:

getXDimension()

x-dimension is the smallest width of the unit of BarCode bars or spaces.
Increase this will increase the whole barcode image width.
Ignored if AutoSizeMode property is set to AutoSizeMode.NEAREST or AutoSizeMode.INTERPOLATION.
Source:

isChecksumEnabled()

Enable checksum during generation 1D barcodes.
Default is treated as Yes for symbology which must contain checksum, as No where checksum only possible.
Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN, Codabar
Checksum always used: Rest symbology
Source:

setBarColor(value)

Bars color.
Parameters:
Name Type Description
value String for Bar color Default value: #000000.
Source:

setBarHeight()

Height of 1D barcodes' bars in Unit value.
Ignored if AutoSizeMode property is set to AutoSizeMode.NEAREST or AutoSizeMode.INTERPOLATION.
Source:
Throws:
BarcodeException

setBarWidthReduction()

Sets bars reduction value that is used to compensate ink spread while printing.
Source:

setChecksumAlwaysShow()

Always display checksum digit in the human readable text for Code128 and GS1Code128 barcodes.
Source:

setChecksumEnabled()

Enable checksum during generation 1D barcodes.
Default is treated as Yes for symbology which must contain checksum, as No where checksum only possible.
Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN, Codabar
Checksum always used: Rest symbology
Source:

setEnableEscape()

Indicates whether explains the character "\" as an escape character in CodeText property. Used for Pdf417, DataMatrix, Code128 only
If the EnableEscape is true, "\" will be explained as a special escape character. Otherwise, "\" acts as normal characters.
Aspose.BarCode supports the decimal ascii code and mnemonic for ASCII control-code characters. For example, \013 and \\CR stands for CR.
Source:

setFilledBars()

Sets a value indicating whether bars filled.
Only for 1D barcodes.
Default value: true.
Source:

setGS1CompositeBar()

GS1 Composite Bar parameters.

This sample shows how to create and save a GS1 Composite Bar image.
Note that 1D codetext and 2D codetext are separated by symbol '/'
Source:
Example
let codetext = "(01)03212345678906/(21)A1B2C3D4E5F6G7H8";
let generator = new BarcodeGenerator(EncodeTypes.GS_1_COMPOSITE_BAR, codetext);

generator.getParameters().getBarcode().getGS1CompositeBar().setLinearComponentType(EncodeTypes.GS_1_CODE_128);
generator.getParameters().getBarcode().getGS1CompositeBar().setTwoDComponentType(TwoDComponentType.CC_A);

// Aspect ratio of 2D component
generator.getParameters().getBarcode().getPdf417().setAspectRatio(3);

// X-Dimension of 1D and 2D components
generator.getParameters().getBarcode().getXDimension().setPixels(3);

// Height of 1D component
generator.getParameters().getBarcode().getBarHeight().setPixels(100);

generator.save("test.png", BarcodeImageFormat.PNG);

setPadding()

Barcode paddings.
Default value: 5pt 5pt 5pt 5pt.
Source:

setWideNarrowRatio()

Wide bars to Narrow bars ratio.
Default value: 3, that is, wide bars are 3 times as wide as narrow bars.
Used for ITF, PZN, PharmaCode, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, IATA2of5,
VIN, DeutschePost, OPC, Code32, DataLogic2of5, PatchCode, Code39Extended, Code39Standard

The WideNarrowRatio parameter value is less than or equal to 0.
Source:

setXDimension()

x-dimension is the smallest width of the unit of BarCode bars or spaces.
Increase this will increase the whole barcode image width.
Ignored if AutoSizeMode property is set to AutoSizeMode.NEAREST or AutoSizeMode.INTERPOLATION.
Source:
Throws:
BarcodeException