BarcodeParameters

BarcodeParameters

Overview

BarcodeParameters is a class in Aspose.Words FOSS for Java.

Container class for barcode parameters to pass-through to BarcodeGenerator.

Edition status of its 49 listed members (a property and its accessor methods are listed separately, overloads once): 49 not yet exercised by a verified example.

This class declares 34 methods for BarcodeParameters objects in Java programs. Available methods include: getAddStartStopChar, getBackgroundColor, getBarcodeType, getBarcodeValue, getCaseCodeStyle, getDisplayText, getErrorCorrectionLevel, getFacingIdentificationMark, getFixCheckDigit, getForegroundColor, getPosCodeStyle, getPostalAddress, and 20 additional methods. Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package. Properties: addStartStopChar, backgroundColor, barcodeType, barcodeValue, bookmark, caseCodeStyle, and 11 more.

Properties

NameTypeAccessDescription
barcodeTypeStringRead/WriteBar code type.
barcodeValueStringRead/WriteData to be encoded.
symbolHeightStringRead/WriteBar code image height (in twips - 1/1440 inches)
foregroundColorStringRead/WriteBar code foreground color (0x000000 - 0xFFFFFF)
backgroundColorStringRead/WriteBar code background color (0x000000 - 0xFFFFFF)
symbolRotationStringRead/WriteRotation of the barcode symbol.
scalingFactorStringRead/WriteScaling factor for the symbol.
posCodeStyleStringRead/WriteStyle of a Point of Sale barcode (barcode types UPCA|UPCE|EAN13|EAN8).
caseCodeStyleStringRead/WriteStyle of a Case Code for barcode type ITF14.
errorCorrectionLevelStringRead/WriteError correction level of QR Code.
displayTextbooleanRead/WriteWhether to display barcode data (text) along with image.
addStartStopCharbooleanRead/WriteWhether to add Start/Stop characters for barcode types NW7 and CODE39.
fixCheckDigitbooleanRead/WriteWhether to fix the check digit if it’s invalid.
postalAddressStringRead/WriteBarcode postal address.
bookmarkbooleanRead/WriteWhether PostalAddress is the name of a bookmark.
facingIdentificationMarkStringRead/WriteType of a Facing Identification Mark (FIM).
uSPostalAddressbooleanRead/WriteWhether PostalAddress is a U.S. postal address.

Methods

SignatureDescription
getBarcodeType() → StringBar code type.
setBarcodeType(value: String)Sets the barcode type value.
getBarcodeValue() → StringData to be encoded.
setBarcodeValue(value: String)Sets the barcode value value.
getSymbolHeight() → StringBar code image height (in twips - 1/1440 inches)
setSymbolHeight(value: String)Sets the symbol height value.
getForegroundColor() → StringBar code foreground color (0x000000 - 0xFFFFFF)
setForegroundColor(value: String)Sets the foreground color value.
getBackgroundColor() → StringBar code background color (0x000000 - 0xFFFFFF)
setBackgroundColor(value: String)Sets the background color value.
getSymbolRotation() → StringRotation of the barcode symbol.
setSymbolRotation(value: String)Sets the symbol rotation value.
getScalingFactor() → StringScaling factor for the symbol.
setScalingFactor(value: String)Sets the scaling factor value.
getPosCodeStyle() → StringStyle of a Point of Sale barcode (barcode types UPCA|UPCE|EAN13|EAN8).
setPosCodeStyle(value: String)Sets the pos code style value.
getCaseCodeStyle() → StringStyle of a Case Code for barcode type ITF14.
setCaseCodeStyle(value: String)Sets the case code style value.
getErrorCorrectionLevel() → StringError correction level of QR Code.
setErrorCorrectionLevel(value: String)Sets the error correction level value.
getDisplayText() → booleanWhether to display barcode data (text) along with image.
setDisplayText(value: boolean)Sets the display text value.
getAddStartStopChar() → booleanWhether to add Start/Stop characters for barcode types NW7 and CODE39.
setAddStartStopChar(value: boolean)Sets the add start stop char value.
getFixCheckDigit() → booleanWhether to fix the check digit if it’s invalid.
setFixCheckDigit(value: boolean)Sets the fix check digit value.
getPostalAddress() → StringBarcode postal address.
setPostalAddress(value: String)Sets the postal address value.
isBookmark() → booleanWhether PostalAddress is the name of a bookmark.
isBookmark(value: boolean)Calls isBookmark(value) on this BarcodeParameters instance.
getFacingIdentificationMark() → StringType of a Facing Identification Mark (FIM).
setFacingIdentificationMark(value: String)Sets the facing identification mark value.
isUSPostalAddress() → booleanWhether PostalAddress is a U.S. postal address.
isUSPostalAddress(value: boolean)Calls isUSPostalAddress(value) on this BarcodeParameters instance.

See Also