Aspose::Words::Fields::FieldAddressBlock class
Contents
[
Hide
]FieldAddressBlock class
Implements the ADDRESSBLOCK field. To learn more, visit the Working with Fields documentation article.
class FieldAddressBlock : public Aspose::Words::Fields::Field,
public Aspose::Words::Fields::IFieldCodeTokenInfoProvider,
public Aspose::Words::Fields::IFormattableMergeField
Methods
| Method | Description |
|---|---|
| FieldAddressBlock() | |
| get_DisplayResult() | Gets the text that represents the displayed field result. |
| get_End() const | Gets the node that represents the field end. |
| get_ExcludedCountryOrRegionName() | Gets or sets the excluded country/region name. |
| get_FieldEnd() const | Gets the node that represents the field end. |
| get_FieldStart() const | Gets the node that represents the start of the field. |
| get_Format() | Gets a FieldFormat object that provides typed access to field’s formatting. |
| get_FormatAddressOnCountryOrRegion() | 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). |
| get_IncludeCountryOrRegionName() | Gets or sets whether to include the name of the country/region. |
| get_IsDirty() | Gets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. |
| get_IsLocked() | Gets or sets whether the field is locked (should not recalculate its result). |
| get_LanguageId() | Gets or sets the language ID used to format the address. |
| get_LocaleId() | Gets or sets the LCID of the field. |
| get_NameAndAddressFormat() | Gets or sets the name and address format. |
| get_Result() | Gets or sets text that is between the field separator and field end. |
| get_Separator() | Gets the node that represents the field separator. Can be null. |
| get_Start() const | Gets the node that represents the start of the field. |
| virtual get_Type() const | Gets the Microsoft Word field type. |
| 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() override | Returns a collection of mail merge field names used by the field. |
| GetType() const override | |
| Is(const System::TypeInfo&) const override | |
| 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. |
| set_ExcludedCountryOrRegionName(const System::String&) | Setter for Aspose::Words::Fields::FieldAddressBlock::get_ExcludedCountryOrRegionName. |
| set_FormatAddressOnCountryOrRegion(bool) | Setter for Aspose::Words::Fields::FieldAddressBlock::get_FormatAddressOnCountryOrRegion. |
| set_IncludeCountryOrRegionName(const System::String&) | Setter for Aspose::Words::Fields::FieldAddressBlock::get_IncludeCountryOrRegionName. |
| set_IsDirty(bool) | Sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. |
| set_IsLocked(bool) | Setter for Aspose::Words::Fields::Field::get_IsLocked. |
| set_LanguageId(const System::String&) | Setter for Aspose::Words::Fields::FieldAddressBlock::get_LanguageId. |
| set_LocaleId(int32_t) | Setter for Aspose::Words::Fields::Field::get_LocaleId. |
| set_NameAndAddressFormat(const System::String&) | Setter for Aspose::Words::Fields::FieldAddressBlock::get_NameAndAddressFormat. |
| set_Result(const System::String&) | Setter for Aspose::Words::Fields::Field::get_Result. |
| static Type() | |
| 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. |
Examples
Shows how to get mail merge field names used by a field.
auto doc = MakeObject<Document>(MyDir + u"Field sample - ADDRESSBLOCK.docx");
ArrayPtr<String> addressFieldsExpect = MakeArray<String>(
{u"Company", u"First Name", u"Middle Name", u"Last Name", u"Suffix", u"Address 1", u"City", u"State", u"Country or Region", u"Postal Code"});
auto addressBlockField = System::ExplicitCast<FieldAddressBlock>(doc->get_Range()->get_Fields()->idx_get(0));
ArrayPtr<String> addressBlockFieldNames = addressBlockField->GetFieldNames();
See Also
- Class Field
- Namespace Aspose::Words::Fields
- Library Aspose.Words for C++