OfficeWriter Documentation
.
WordWriter v8 Docs
Space Shortcuts
Page tree
ConfigureSpace tools

Versions Compared

Old Version 5

changes.mady.by.user Wiki Administrator

Saved on

compared with

New Version Current

changes.mady.by.user Wiki Administrator

Saved on

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}{signature:
}
Signature
vb.net
vb.net
Public Function BookmarkFieldMarkers(ByVal aBookmark As String) As String()
{signature}
{parameters}
{param:aBookmark}{param}
{returns}The names of all merge fields in the specified bookmark.{returns}
{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.

{remarks}
{example}{code:csharp|title=C#}
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} {code:
 Code Block
vb.net
|title=
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))
        
{code}

{example}