MailMergeRegionInfo Class

Contains information about a mail merge region.

Inheritance Hierarchy


Namespace:  Aspose.Words.MailMerging
Assembly:  Aspose.Words (in Aspose.Words.dll) Version: 20.8.0


public class MailMergeRegionInfo

The MailMergeRegionInfo type exposes the following members.


Public propertyCode exampleEndField
Returns an end field for the region.
Public propertyCode exampleFields
Returns a list of child fields.
Public propertyCode exampleLevel
Returns the nesting level for the region.
Public propertyCode exampleName
Returns the name of region.
Public propertyCode exampleRegions
Returns a list of child regions.
Public propertyCode exampleStartField
Returns a start field for the region.


Public methodEquals (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodToString (Inherited from Object.)


Shows how to get MailMergeRegionInfo and work with it.
Document doc = new Document(MyDir + "Mail merge regions.docx");

// Returns a full hierarchy of regions (with fields) available in the document
MailMergeRegionInfo regionInfo = doc.MailMerge.GetRegionsHierarchy();

// Get top regions in the document
IList<MailMergeRegionInfo> topRegions = regionInfo.Regions;
Assert.AreEqual(2, topRegions.Count);
Assert.AreEqual("Region1", topRegions[0].Name);
Assert.AreEqual("Region2", topRegions[1].Name);
Assert.AreEqual(1, topRegions[0].Level);
Assert.AreEqual(1, topRegions[1].Level);

// Get nested region in first top region
IList<MailMergeRegionInfo> nestedRegions = topRegions[0].Regions;
Assert.AreEqual(2, nestedRegions.Count);
Assert.AreEqual("NestedRegion1", nestedRegions[0].Name);
Assert.AreEqual("NestedRegion2", nestedRegions[1].Name);
Assert.AreEqual(2, nestedRegions[0].Level);
Assert.AreEqual(2, nestedRegions[1].Level);

// Get field list in first top region
IList<Field> fieldList = topRegions[0].Fields;
Assert.AreEqual(4, fieldList.Count);

FieldMergeField startFieldMergeField = nestedRegions[0].StartField;
Assert.AreEqual("TableStart:NestedRegion1", startFieldMergeField.FieldName);

FieldMergeField endFieldMergeField = nestedRegions[0].EndField;
Assert.AreEqual("TableEnd:NestedRegion1", endFieldMergeField.FieldName);

See Also