FieldMergeBarcode
Overview
FieldMergeBarcode is a class in Aspose.Words FOSS for Java.
Inherits from: Field, IFieldCodeTokenInfoProvider, IMergeFieldSurrogate.
Implements the MERGEBARCODE field.
Edition status of its 66 listed members (a property and its accessor methods are listed separately, overloads once): 66 not yet exercised by a verified example.
This class declares 46 methods for FieldMergeBarcode objects in Java programs.
Available methods include: getAddStartStopChar, getBackgroundColor, getBarcodeType, getBarcodeValue, getCaseCodeStyle, getDisplayResult, getDisplayText, getEnd, getErrorCorrectionLevel, getFieldCode, getFixCheckDigit, getForegroundColor, and 30 additional methods.
Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package.
Properties: addStartStopChar, backgroundColor, barcodeType, barcodeValue, caseCodeStyle, dirty, and 18 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
barcodeValue | String | Read/Write | Gets or sets the barcode value. |
barcodeType | String | Read/Write | Gets or sets the barcode type (QR, etc.) |
symbolHeight | String | Read/Write | Gets or sets the height of the symbol. |
symbolRotation | String | Read/Write | Gets or sets the rotation of the barcode symbol. |
scalingFactor | String | Read/Write | Gets or sets a scaling factor for the symbol. |
foregroundColor | String | Read/Write | Gets or sets the foreground color of the barcode symbol. |
backgroundColor | String | Read/Write | Gets or sets the background color of the barcode symbol. |
posCodeStyle | String | Read/Write | Gets or sets the style of a Point of Sale barcode (barcode types UPCA|UPCE|EAN13|EAN8). |
caseCodeStyle | String | Read/Write | Gets or sets the style of a Case Code for barcode type ITF14. |
errorCorrectionLevel | String | Read/Write | Gets or sets an error correction level of QR Code. |
displayText | boolean | Read/Write | Gets or sets whether to display barcode data (text) along with image. |
addStartStopChar | boolean | Read/Write | Gets or sets whether to add Start/Stop characters for barcode types NW7 and CODE39. |
fixCheckDigit | boolean | Read/Write | Gets or sets whether to fix the check digit if it’s invalid. |
fieldCode | String | Read | Returns text between field start and field separator (or field end if there is no separator). |
start | FieldStart | Read | Gets the node that represents the start of the field. |
separator | FieldSeparator | Read | Gets the node that represents the field separator. |
end | FieldEnd | Read | Gets the node that represents the field end. |
type | int | Read | Gets the type. |
result | String | Read/Write | Gets or sets text that is between the field separator and field end. |
displayResult | String | Read | Gets the text that represents the displayed field result. |
locked | boolean | Read/Write | Gets or sets whether the field is locked (should not recalculate its result). |
dirty | boolean | Read/Write | Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. |
format | FieldFormat | Read | Gets a FieldFormat object that provides typed access to field’s formatting. |
localeId | int | Read/Write | Gets or sets the LCID of the field. |
Methods
| Signature | Description |
|---|---|
getBarcodeValue() → String | Gets or sets the barcode value. |
setBarcodeValue(value: String) | Sets the barcode value value. |
getBarcodeType() → String | Gets or sets the barcode type (QR, etc.) |
setBarcodeType(value: String) | Sets the barcode type value. |
getSymbolHeight() → String | Gets or sets the height of the symbol. |
setSymbolHeight(value: String) | Sets the symbol height value. |
getSymbolRotation() → String | Gets or sets the rotation of the barcode symbol. |
setSymbolRotation(value: String) | Sets the symbol rotation value. |
getScalingFactor() → String | Gets or sets a scaling factor for the symbol. |
setScalingFactor(value: String) | Sets the scaling factor value. |
getForegroundColor() → String | Gets or sets the foreground color of the barcode symbol. |
setForegroundColor(value: String) | Sets the foreground color value. |
getBackgroundColor() → String | Gets or sets the background color of the barcode symbol. |
setBackgroundColor(value: String) | Sets the background color value. |
getPosCodeStyle() → String | Gets or sets the style of a Point of Sale barcode (barcode types UPCA|UPCE|EAN13|EAN8). |
setPosCodeStyle(value: String) | Sets the pos code style value. |
getCaseCodeStyle() → String | Gets or sets the style of a Case Code for barcode type ITF14. |
setCaseCodeStyle(value: String) | Sets the case code style value. |
getErrorCorrectionLevel() → String | Gets or sets an error correction level of QR Code. |
setErrorCorrectionLevel(value: String) | Sets the error correction level value. |
getDisplayText() → boolean | Gets or sets whether to display barcode data (text) along with image. |
setDisplayText(value: boolean) | Sets the display text value. |
getAddStartStopChar() → boolean | Gets or sets whether to add Start/Stop characters for barcode types NW7 and CODE39. |
setAddStartStopChar(value: boolean) | Sets the add start stop char value. |
getFixCheckDigit() → boolean | Gets or sets whether to fix the check digit if it’s invalid. |
setFixCheckDigit(value: boolean) | Sets the fix check digit value. |
getFieldCode() → String | Returns text between field start and field separator (or field end if there is no separator). |
getFieldCode(includeChildFieldCodes: boolean) → String | Returns text between field start and field separator (or field end if there is no separator). |
remove() → Node | Removes the field from the document. |
update() | Performs the field update. |
update(ignoreMergeFormat: boolean) | Performs a field update. |
unlink() → boolean | Performs the field unlink. |
getStart() → FieldStart | Gets the node that represents the start of the field. |
getSeparator() → FieldSeparator | Gets the node that represents the field separator. |
getEnd() → FieldEnd | Gets the node that represents the field end. |
getType() → int | Returns the type. |
getResult() → String | Gets or sets text that is between the field separator and field end. |
setResult(value: String) | Sets the result value. |
getDisplayResult() → String | Gets the text that represents the displayed field result. |
isLocked() → boolean | Gets or sets whether the field is locked (should not recalculate its result). |
isLocked(value: boolean) | Calls isLocked(value) on this FieldMergeBarcode instance. |
isDirty() → boolean | Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. |
isDirty(value: boolean) | Calls isDirty(value) on this FieldMergeBarcode instance. |
getFormat() → FieldFormat | Gets a FieldFormat object that provides typed access to field’s formatting. |
getLocaleId() → int | Gets or sets the LCID of the field. |
setLocaleId(value: int) | Sets the locale id value. |