How to: Programmatically Update Bookmark Text

 

You can insert text into a placeholder bookmark in a Microsoft Office Word document so that you can retrieve the text at a later time, or to replace text in a bookmark. If you are developing a document-level customization, you can also update text in a Microsoft.Office.Tools.Word.Bookmark control that is bound to data. For more information, see Binding Data to Controls in Office Solutions.

Applies to: The information in this topic applies to document-level projects and VSTO add-in projects for Word. For more information, see Features Available by Office Application and Project Type.

The bookmark object can be one of two types:

When you assign text to a bookmark, the behavior differs between a Microsoft.Office.Interop.Word.Bookmark and a Microsoft.Office.Tools.Word.Bookmark. For more information, see Bookmark Control.

To update bookmark contents using a Bookmark control

  1. Create a procedure that takes a bookmark argument for the name of the bookmark, and a newText argument for the string to assign to the Text property.

    System_CAPS_ICON_note.jpg Note


    Assigning text to the Bookmark.Text or Bookmark.FormattedText property of a Microsoft.Office.Tools.Word.Bookmark control does not cause the bookmark to be deleted.

            static void BookMarkReplace(
                ref Microsoft.Office.Tools.Word.Bookmark bookmark, 
                string newText)
            {
    

  2. Assign the newText string to the Text property of the Microsoft.Office.Tools.Word.Bookmark.

                bookmark.Text = newText;
            }
    

To update bookmark contents using a Word Bookmark object

  1. Create a procedure that has a bookmark argument for the name of the Microsoft.Office.Interop.Word.Bookmark, and a newText argument for the string to assign to the P:Microsoft.Office.Interop.Word.Range.Text property of the bookmark.

    System_CAPS_ICON_note.jpg Note


    Assigning text to a native Word Microsoft.Office.Interop.Word.Bookmark object causes the bookmark to be deleted.

            internal void BookMarkReplaceNative(
                Word.Bookmark bookmark, 
                string newText)
            {
    

  2. Assign the newText string to the P:Microsoft.Office.Interop.Word.Range.Text property of the bookmark, which automatically deletes the bookmark. Then re-add the bookmark to the Bookmarks collection.

    The following code example can be used in a document-level customization.

                object rng = bookmark.Range;
                string bookmarkName = bookmark.Name;
            
                bookmark.Range.Text = newText;
    
                this.Bookmarks.Add(bookmarkName, ref rng); 
            }
    

    The following code example can be used in a VSTO Add-in. This example uses the active document.

                object rng = bookmark.Range;
                string bookmarkName = bookmark.Name;
    
                bookmark.Range.Text = newText;
    
                Word.Document document = this.Application.ActiveDocument;
                document.Bookmarks.Add(bookmarkName, ref rng);
            }
    

How to: Programmatically Insert Text into Word Documents
Word Object Model Overview
Bookmark Control

Show: