FieldAddressBlock

FieldAddressBlock class

Implements the ADDRESSBLOCK field.

public class FieldAddressBlock : Field

Constructors

Name Description
FieldAddressBlock() The default constructor.

Properties

Name Description
DisplayResult { get; } Gets the text that represents the displayed field result.
End { get; } Gets the node that represents the field end.
ExcludedCountryOrRegionName { get; set; } Gets or sets the excluded country/region name.
Format { get; } Gets a FieldFormat object that provides typed access to field’s formatting.
FormatAddressOnCountryOrRegion { get; set; } 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 { get; set; } Gets or sets whether to include the name of the country/region.
IsDirty { get; set; } Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
IsLocked { get; set; } Gets or sets whether the field is locked (should not recalculate its result).
LanguageId { get; set; } Gets or sets the language ID used to format the address.
LocaleId { get; set; } Gets or sets the LCID of the field.
NameAndAddressFormat { get; set; } Gets or sets the name and address format.
Result { get; set; } Gets or sets text that is between the field separator and field end.
Separator { get; } Gets the node that represents the field separator. Can be null.
Start { get; } Gets the node that represents the start of the field.
virtual Type { get; } Gets the Microsoft Word field type.

Methods

Name Description
GetFieldCode() Returns text between field start and field separator (or field end if there is no separator). Both field code and field result of child fields are included.
GetFieldCode(bool) Returns text between field start and field separator (or field end if there is no separator).
GetFieldNames() Returns a collection of mail merge field names used by the field.
Remove() Removes the field from the document. Returns a node right after the field. If the field’s end is the last child of its parent node, returns its parent paragraph. If the field is already removed, returns null.
Unlink() Performs the field unlink.
Update() Performs the field update. Throws if the field is being updated already.
Update(bool) Performs a field update. Throws if the field is being updated already.

Remarks

Represents an address block. An address block is a block of text specifying information appropriate for a postal mailing address, in the order required by the destination country.

Examples

Shows how to get mail merge field names used by a field.

Document doc = new Document(MyDir + "Field sample - ADDRESSBLOCK.docx");

string[] addressFieldsExpect =
{
    "Company", "First Name", "Middle Name", "Last Name", "Suffix", "Address 1", "City", "State",
    "Country or Region", "Postal Code"
};

FieldAddressBlock addressBlockField = (FieldAddressBlock) doc.Range.Fields[0];
string[] addressBlockFieldNames = addressBlockField.GetFieldNames();

See Also