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

Returns the names of all merge fields in the specified bookmark.

Signature
C#
C#
 public System.String[] BookmarkFieldMarkers(System.String aBookmark)
Signature
vb.net
vb.net
Public Function BookmarkFieldMarkers(ByVal aBookmark As String) As String()
Parameters
Param
aBookmark
aBookmark

Returns

The names of all merge fields in the specified bookmark.

Remarks

Bookmarks are used to define repeat blocks. A repeat block is a fragment in the template document that contains merge fields and that will be repeated for each row in a data source.

Example
Code Block
csharp
csharp
titleC#

          //--- Create the WordTemplate object.
          WordTemplate oWW = new WordTemplate();

          //--- Open a template using a string.
          oWW.Open(@"C:\template.doc");

          //--- Get all the bookmark names in the document.
          String[] allBookmarks = oWW.Bookmarks;

          //--- Get all the merge fields in the first bookmark.
          String[] someFields = oWW.BookmarkFieldMarkers(allBookmarks[0]);
        
Code Block
vb.net
vb.net
titlevb.net

          '--- Create the WordTemplate object.
          Dim oWW As New WordTemplate()

          '--- Open a template using a string.
          oWW.Open("C:\template.doc")

          '--- Get all the bookmark names in the document.
          Dim allBookmarks As String() = oWW.Bookmarks

          '--- Get all the merge fields in the first bookmark.
          Dim someFields As String() = oWW.BookmarkFieldMarkers(allBookmarks(0))