Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
Description

Excerpt

This class represents a merge field in a document. Merge fields are used in WordWriter templates as data placeholders.

Signature
C#
C#
 public sealed class MergeField : Field
Signature
vb.net
vb.net
Public NotInheritable Class MergeField
		Inherits Field
Remarks

To create a merge field, use Element.InsertMergeFieldBefore or Element.InsertMergeFieldAfter.

The following sample demonstrates creating a merge field at the end of a new document and retrieving the first merge field of an existing document.

Example
Code Block
csharp
csharp
titleC#

          //--- Insert a merge field at the end of a new document
          WordApplication app = new WordApplication();
          Document doc = app.Create();
          MergeField mfield = doc.InsertMergeFieldAfter("FieldName", "FieldName");

          //--- Get the first merge field of an existing document
          WordApplication app = new WordApplication();
          Document doc = app.Open(@"C:\sample.doc");
          MergeField firstMergeField = doc.GetElements(Element.Type.MergeField)[0];
        
Code Block
vb.net
vb.net
titlevb.net

          '--- Insert a merge field at the end of a new document
          Dim app As New WordApplication()
          Dim doc As Document = app.Create()
          Dim mfield As Field = doc.InsertMergeFieldAfter("FieldName", "FieldName")

          '--- Get the first merge field of an existing document
          Dim app As New WordApplication()
          Dim doc As Document = app.Open("C:\sample.doc")
          Dim firstMergeField As MergeField = doc.GetElements(Element.Type.MergeField)(0)
        
Methods

Name

Description

GetFieldName()

Excerpt Include
MergeField.GetFieldName()
MergeField.GetFieldName()
nopaneltrue