FieldAddressBlock

FieldAddressBlock

Overview

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

Implements the ADDRESSBLOCK field.

This class provides 4 methods for working with FieldAddressBlock objects in .NET programs. Available methods include: GetFieldCode, Remove, Unlink, Update. All public members are accessible to any .NET application after installing the Aspose.Words FOSS for .NET package. Properties: DisplayResult, End, ExcludedCountryOrRegionName, Format, FormatAddressOnCountryOrRegion, IncludeCountryOrRegionName, and 9 more.

Properties

NameTypeAccessDescription
FormatAddressOnCountryOrRegionboolRead/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.
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.
TypeFieldTypeReadGets the Microsoft Word field type.
ResultstringRead/WriteGets or sets text that is between the field separator and field end.
DisplayResultstringReadGets the text that represents the displayed field result.
IsLockedboolRead/WriteGets or sets whether the field is locked (should not recalculate its result).
IsDirtyboolRead/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
GetFieldCode()Returns text between field start and field separator (or field end if there is no separator).
Remove()Removes the field from the document.
Update()Performs the field update.
Unlink()Performs the field unlink.

See Also