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
| Name | Type | Access | Description |
|---|---|---|---|
formatAddressOnCountryOrRegion | boolean | Read/Write | Gets or sets whether to format the address according to the country/region of the recipient as defined by POST*CODE (Universal Postal Union 2006). |
includeCountryOrRegionName | String | Read/Write | Gets or sets whether to include the name of the country/region. |
excludedCountryOrRegionName | String | Read/Write | Gets or sets the excluded country/region name. |
nameAndAddressFormat | String | Read/Write | Gets or sets the name and address format. |
languageId | String | Read/Write | Gets or sets the language ID used to format the address. |
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 |
|---|---|
getFormatAddressOnCountryOrRegion() → boolean | Gets 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() → String | Gets or sets whether to include the name of the country/region. |
setIncludeCountryOrRegionName(value: String) | Sets the include country or region name value. |
getExcludedCountryOrRegionName() → String | Gets or sets the excluded country/region name. |
setExcludedCountryOrRegionName(value: String) | Sets the excluded country or region name value. |
getNameAndAddressFormat() → String | Gets or sets the name and address format. |
setNameAndAddressFormat(value: String) | Sets the name and address format value. |
getLanguageId() → String | Gets or sets the language ID used to format the address. |
setLanguageId(value: String) | Sets the language id 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 FieldAddressBlock 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 FieldAddressBlock 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. |