FieldMergeRec Class

Implements the MERGEREC field.

Inheritance Hierarchy

SystemObject
Aspose.Words.FieldsField
Aspose.Words.FieldsFieldMergeRec

Namespace: Aspose.Words.Fields
Assembly: Aspose.Words (in Aspose.Words.dll) Version: 20.3

Syntax

C++

public class FieldMergeRec : Field

Public Class FieldMergeRec
	Inherits Field

public ref class FieldMergeRec : public Field

type FieldMergeRec =  
    class
        inherit Field
    end

The FieldMergeRec type exposes the following members.

Constructors

	Name	Description
	FieldMergeRec	Initializes a new instance of the FieldMergeRec class

Properties

	Name	Description
	DisplayResult	Gets the text that represents the displayed field result. (Inherited from Field.)
	End	Gets the node that represents the field end. (Inherited from Field.)
	Format	Gets a FieldFormat object that provides typed access to field's formatting. (Inherited from Field.)
	IsDirty	Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. (Inherited from Field.)
	IsLocked	Gets or sets whether the field is locked (should not recalculate its result). (Inherited from Field.)
	LocaleId	Gets or sets the LCID of the field. (Inherited from Field.)
	Result	Gets or sets text that is between the field separator and field end. (Inherited from Field.)
	Separator	Gets the node that represents the field separator. Can be null. (Inherited from Field.)
	Start	Gets the node that represents the start of the field. (Inherited from Field.)
	Type	Gets the Microsoft Word field type. (Inherited from Field.)

Methods

	Name	Description
	Equals	(Inherited from Object.)
	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. (Inherited from Field.)
	GetFieldCode(Boolean)	Returns text between field start and field separator (or field end if there is no separator). (Inherited from Field.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	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. (Inherited from Field.)
	ToString	(Inherited from Object.)
	Unlink	Performs the field unlink. (Inherited from Field.)
	Update	Performs the field update. Throws if the field is being updated already. (Inherited from Field.)
	Update(Boolean)	Performs a field update. Throws if the field is being updated already. (Inherited from Field.)

Remarks

At the moment the MERGEREC and MERGESEQ fields implement the same functionality because we don't know for sure how to skip records in Aspose.Words mail merge.

Examples

Shows how to number and count mail merge records in the output documents of a mail merge using MERGEREC and MERGESEQ fields.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Use a document builder to insert a merge field
builder.Write("Dear ");
FieldMergeField fieldMergeField = (FieldMergeField)builder.InsertField(FieldType.FieldMergeField, true);
fieldMergeField.FieldName = "Name";
builder.Writeln(",");

// A MERGEREC field will print the row number of the data being merged
builder.Write("\nRow number of record in data source: ");
FieldMergeRec fieldMergeRec = (FieldMergeRec)builder.InsertField(FieldType.FieldMergeRec, true);

Assert.AreEqual(" MERGEREC ", fieldMergeRec.GetFieldCode());

// A MERGESEQ field will count the number of successful merges and print the current value on each respective page
// If no rows are skipped and the data source is not sorted, and no SKIP/SKIPIF/NEXT/NEXTIF fields are invoked,
// the MERGESEQ and MERGEREC fields will function the same
builder.Write("\nSuccessful merge number: ");
FieldMergeSeq fieldMergeSeq = (FieldMergeSeq)builder.InsertField(FieldType.FieldMergeSeq, true);

Assert.AreEqual(" MERGESEQ ", fieldMergeSeq.GetFieldCode());

// Insert a SKIPIF field, which will skip a merge if the name is "John Doe"
FieldSkipIf fieldSkipIf = (FieldSkipIf)builder.InsertField(FieldType.FieldSkipIf, true);
builder.MoveTo(fieldSkipIf.Separator);
fieldMergeField = (FieldMergeField)builder.InsertField(FieldType.FieldMergeField, true);
fieldMergeField.FieldName = "Name";
fieldSkipIf.LeftExpression = "=";
fieldSkipIf.RightExpression = "John Doe";

// Create a data source with 3 rows, one of them having "John Doe" as a value for the "Name" column
// Since a SKIPIF field will be triggered once by that value, the output of our mail merge will have 2 pages instead of 3
// On page 1, the MERGESEQ and MERGEREC fields will both display "1"
// On page 2, the MERGEREC field will display "3" and the MERGESEQ field will display "2"
DataTable table = CreateTable("Employees", new[] { "Name" },
    new[,] { { "Jane Doe" }, { "John Doe" }, { "Joe Bloggs" } });

// Execute mail merge and save document
doc.MailMerge.Execute(table);
doc.Save(ArtifactsDir + "Field.MERGEREC.MERGESEQ.docx");

Reference

Aspose.Words.Fields Namespace