FieldBarcode

Overview

FieldBarcode is a class in Aspose.Words FOSS for Java. Inherits from: Field, IFieldCodeTokenInfoProvider.

Implements the BARCODE field.

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

This class declares 28 methods for FieldBarcode objects in Java programs. Available methods include: getDisplayResult, getEnd, getFacingIdentificationMark, getFieldCode, getFormat, getLocaleId, getPostalAddress, getResult, getSeparator, getStart, getType, isBookmark, and 10 additional methods. Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package. Properties: bookmark, dirty, displayResult, end, facingIdentificationMark, fieldCode, and 9 more.

Properties

NameTypeAccessDescription
postalAddressStringRead/WriteGets or sets the postal address used for generating a barcode or the name of the bookmark that refers to it.
bookmarkbooleanRead/WriteGets or sets whether PostalAddress is the name of a bookmark.
facingIdentificationMarkStringRead/WriteGets or sets the type of a Facing Identification Mark (FIM) to insert.
uSPostalAddressbooleanRead/WriteGets or sets whether PostalAddress is a U.S. postal address.
fieldCodeStringReadReturns text between field start and field separator (or field end if there is no separator).
startFieldStartReadGets the node that represents the start of the field.
separatorFieldSeparatorReadGets the node that represents the field separator.
endFieldEndReadGets the node that represents the field end.
typeintReadGets the type.
resultStringRead/WriteGets or sets text that is between the field separator and field end.
displayResultStringReadGets the text that represents the displayed field result.
lockedbooleanRead/WriteGets or sets whether the field is locked (should not recalculate its result).
dirtybooleanRead/WriteGets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
formatFieldFormatReadGets a FieldFormat object that provides typed access to field’s formatting.
localeIdintRead/WriteGets or sets the LCID of the field.

Methods

SignatureDescription
getPostalAddress() → StringGets or sets the postal address used for generating a barcode or the name of the bookmark that refers to it.
setPostalAddress(value: String)Sets the postal address value.
isBookmark() → booleanGets or sets whether PostalAddress is the name of a bookmark.
isBookmark(value: boolean)Calls isBookmark(value) on this FieldBarcode instance.
getFacingIdentificationMark() → StringGets or sets the type of a Facing Identification Mark (FIM) to insert.
setFacingIdentificationMark(value: String)Sets the facing identification mark value.
isUSPostalAddress() → booleanGets or sets whether PostalAddress is a U.S. postal address.
isUSPostalAddress(value: boolean)Calls isUSPostalAddress(value) on this FieldBarcode instance.
getFieldCode() → StringReturns text between field start and field separator (or field end if there is no separator).
getFieldCode(includeChildFieldCodes: boolean) → StringReturns text between field start and field separator (or field end if there is no separator).
remove() → NodeRemoves the field from the document.
update()Performs the field update.
update(ignoreMergeFormat: boolean)Performs a field update.
unlink() → booleanPerforms the field unlink.
getStart() → FieldStartGets the node that represents the start of the field.
getSeparator() → FieldSeparatorGets the node that represents the field separator.
getEnd() → FieldEndGets the node that represents the field end.
getType() → intReturns the type.
getResult() → StringGets or sets text that is between the field separator and field end.
setResult(value: String)Sets the result value.
getDisplayResult() → StringGets the text that represents the displayed field result.
isLocked() → booleanGets or sets whether the field is locked (should not recalculate its result).
isLocked(value: boolean)Calls isLocked(value) on this FieldBarcode instance.
isDirty() → booleanGets 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 FieldBarcode instance.
getFormat() → FieldFormatGets a FieldFormat object that provides typed access to field’s formatting.
getLocaleId() → intGets or sets the LCID of the field.
setLocaleId(value: int)Sets the locale id value.

See Also