FieldAddressBlock

FieldAddressBlock

Overview

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

Implements the ADDRESSBLOCK field.

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

This class declares 30 methods for FieldAddressBlock objects in Java programs. Available methods include: getDisplayResult, getEnd, getExcludedCountryOrRegionName, getFieldCode, getFormat, getFormatAddressOnCountryOrRegion, getIncludeCountryOrRegionName, getLanguageId, getLocaleId, getNameAndAddressFormat, getResult, getSeparator, and 14 additional methods. Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package. Properties: dirty, displayResult, end, excludedCountryOrRegionName, fieldCode, format, and 10 more.

Properties

NameTypeAccessDescription
formatAddressOnCountryOrRegionbooleanRead/WriteGets or sets whether to format the address according to the country/region of the recipient as defined by POST*CODE (Universal Postal Union 2006).
includeCountryOrRegionNameStringRead/WriteGets or sets whether to include the name of the country/region.
excludedCountryOrRegionNameStringRead/WriteGets or sets the excluded country/region name.
nameAndAddressFormatStringRead/WriteGets or sets the name and address format.
languageIdStringRead/WriteGets or sets the language ID used to format the 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
getFormatAddressOnCountryOrRegion() → booleanGets or sets whether to format the address according to the country/region of the recipient as defined by POST*CODE (Universal Postal Union 2006).
setFormatAddressOnCountryOrRegion(value: boolean)Sets the format address on country or region value.
getIncludeCountryOrRegionName() → StringGets or sets whether to include the name of the country/region.
setIncludeCountryOrRegionName(value: String)Sets the include country or region name value.
getExcludedCountryOrRegionName() → StringGets or sets the excluded country/region name.
setExcludedCountryOrRegionName(value: String)Sets the excluded country or region name value.
getNameAndAddressFormat() → StringGets or sets the name and address format.
setNameAndAddressFormat(value: String)Sets the name and address format value.
getLanguageId() → StringGets or sets the language ID used to format the address.
setLanguageId(value: String)Sets the language id value.
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 FieldAddressBlock 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 FieldAddressBlock 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