BarcodeParameters Class Reference

Inherits BaseJavaClass.

Public Member Functions
	getPatchCode ()
	getXDimension ()
	setXDimension (Unit $value)
	getBarWidthReduction ()
	setBarWidthReduction (Unit $value)
	getBarHeight ()
	setBarHeight (Unit $value)
	getAutoSizeMode ()
	setAutoSizeMode ($value)
	getBarCodeHeight ()
	setBarCodeHeight (Unit $value)
	getBarCodeWidth ()
	setBarCodeWidth (Unit $value)
	getForeColor ()
	setForeColor ($value)
	getBarColor ()
	setBarColor ($value)
	getPadding ()
	setPadding (Padding $value)
	getChecksumAlwaysShow ()
	setChecksumAlwaysShow ($value)
	isChecksumEnabled ()
	setChecksumEnabled ($value)
	getEnableEscape ()
	setEnableEscape ($value)
	getWideNarrowRatio ()
	setWideNarrowRatio ($value)
	getCodeTextParameters ()
	getFilledBars ()
	setFilledBars ($value)
	getPostal ()
	getAustralianPost ()
	getDataBar ()
	getCodablock ()
	getDataMatrix ()
	getCode16K ()
	getDotCode ()
	getITF ()
	getPdf417 ()
	getQR ()
	getSupplement ()
	getMaxiCode ()
	getAztec ()
	getCodabar ()
	getCoupon ()

Private Member Functions
	setPatchCode (PatchCodeParameters $value)

Detailed Description

Barcode generation parameters.

Member Function Documentation

getAustralianPost()

getAustralianPost

(

)

AustralianPost barcode parameters.

getAutoSizeMode()

getAutoSizeMode

(

)

Specifies the different types of automatic sizing modes. Default value: AutoSizeMode::NONE.

Deprecated:

"This method is obsolete. Call BaseGenerationParameters->getAutoSizeMode() instead."

Exceptions

BarcodeException

getAztec()

getAztec

(

)

Aztec parameters.

getBarCodeHeight()

getBarCodeHeight

(

)

BarCode image height when AutoSizeMode property is set to AutoSizeMode::NEAREST or AutoSizeMode::INTERPOLATION.

Deprecated:

"This method is obsolete. Call BaseGenerationParameters->getImageHeight() instead."

getBarCodeWidth()

getBarCodeWidth

(

)

BarCode image width when AutoSizeMode property is set to AutoSizeMode::NEAREST or AutoSizeMode::INTERPOLATION.

Deprecated:

"This method is obsolete. Call BaseGenerationParameters->getImageWidth() instead."

getBarColor()

getBarColor

(

)

Bars color. Default value: #000000

getBarHeight()

getBarHeight

(

)

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

Exceptions

BarcodeException

getBarWidthReduction()

getBarWidthReduction

(

)

Get bars reduction value that is used to compensate ink spread while printing.

Returns

Unit value of BarWidthReduction

getChecksumAlwaysShow()

getChecksumAlwaysShow

(

)

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

getCodabar()

getCodabar

(

)

Codabar parameters.

getCodablock()

getCodablock

(

)

Codablock parameters.

getCode16K()

getCode16K

(

)

Code16K parameters.

getCodeTextParameters()

getCodeTextParameters

(

)

Codetext parameters.

getCoupon()

getCoupon

(

)

Coupon parameters. Used for UpcaGs1DatabarCoupon, UpcaGs1Code128Coupon.

getDataBar()

getDataBar

(

)

Databar parameters.

getDataMatrix()

getDataMatrix

(

)

DataMatrix parameters.

getDotCode()

getDotCode

(

)

DotCode parameters.

getEnableEscape()

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.

getFilledBars()

getFilledBars

(

)

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

getForeColor()

getForeColor

(

)

Bars color. Default value: #000000.

Deprecated:

"This method is obsolete. Call BarcodeParameters->getBarColor() instead."

getITF()

getITF

(

)

ITF parameters.

getMaxiCode()

getMaxiCode

(

)

MaxiCode parameters.

getPadding()

getPadding

(

)

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

getPatchCode()

getPatchCode

(

)

PatchCode parameters.

getPdf417()

getPdf417

(

)

PDF417 parameters.

getPostal()

getPostal

(

)

Postal parameters. Used for Postnet, Planet.

getQR()

getQR

(

)

QR parameters.

getSupplement()

getSupplement

(

)

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

getWideNarrowRatio()

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

Exceptions

IllegalArgumentException

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

getXDimension()

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.

isChecksumEnabled()

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

setAutoSizeMode()

setAutoSizeMode

(

$value

)

Specifies the different types of automatic sizing modes. Default value: AutoSizeMode::NONE.

Deprecated:

"This method is obsolete. Call BaseGenerationParameters->setAutoSizeMode() instead."

Exceptions

BarcodeException

setBarCodeHeight()

setBarCodeHeight

(

Unit

$value

)

BarCode image height when AutoSizeMode property is set to AutoSizeMode::NEAREST or AutoSizeMode::INTERPOLATION.

Deprecated:

"This method is obsolete. Call BaseGenerationParameters->setImageHeight() instead."

setBarCodeWidth()

setBarCodeWidth

(

Unit

$value

)

BarCode image width when AutoSizeMode property is set to AutoSizeMode::NEAREST or AutoSizeMode::INTERPOLATION.

Deprecated:

"This method is obsolete. Call BaseGenerationParameters->setImageWidth() instead."

setBarColor()

setBarColor

(

$value

)

Bars color. Default value: #000000.

setBarHeight()

setBarHeight

(

Unit

$value

)

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

Exceptions

BarcodeException

setBarWidthReduction()

setBarWidthReduction

(

Unit

$value

)

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

setChecksumAlwaysShow()

setChecksumAlwaysShow

(

$value

)

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

setChecksumEnabled()

setChecksumEnabled

(

$value

)

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

setEnableEscape()

setEnableEscape

(

$value

)

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.

setFilledBars()

setFilledBars

(

$value

)

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

setForeColor()

setForeColor

(

$value

)

Bars color. Default value Black.

Deprecated:

"This method is obsolete. Call BarcodeParameters->setBarColor() instead."

setPadding()

setPadding

(

Padding

$value

)

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

setPatchCode()

setPatchCode ( PatchCodeParameters  $value )

private

PatchCode parameters.

setWideNarrowRatio()

setWideNarrowRatio

(

$value

)

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

Exceptions

IllegalArgumentException

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

setXDimension()

setXDimension

(

Unit

$value

)

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.

Exceptions

BarcodeException