How to Use VBA to Add Bookmarks Programmatically

You need to add bookmarks to a Word document without clicking through the Insert tab each time. Bookmarks let you mark specific locations or text ranges so you can jump to them, cross-reference them, or update them with field codes. This article explains how to use VBA to add bookmarks programmatically, covering the essential objects, methods, and common pitfalls. By the end you will be able to write a macro that inserts a bookmark, name it correctly, and verify that it was created.

Key Takeaways: Adding Bookmarks With VBA

ActiveDocument.Bookmarks.Add Name:=”MyBookmark”, Range:=Selection.Range: Creates a bookmark at the current cursor position or selected text.
Bookmark names cannot contain spaces or start with a number: Use underscores or camelCase to avoid runtime error 5941.
Check if a bookmark exists before adding it: Use a For Each loop or a helper function to prevent duplicate name errors.
Use Range objects instead of Selection: Faster execution and no screen flicker when adding bookmarks programmatically.
Bookmarks survive save and close: They persist as part of the document unless explicitly deleted.

Understanding the VBA Bookmark Object Model

In Word VBA, a bookmark is represented by the Bookmark object. All bookmarks in a document belong to the Bookmarks collection, which you access via ActiveDocument.Bookmarks. The collection supports adding, deleting, and counting bookmarks. Each bookmark has a Name property (a string) and a Range property that returns the Range object the bookmark covers.

A bookmark can cover a single point (collapsed range) or a block of text. When you add a bookmark, you supply a name and a Range object. If you omit the Range parameter, Word adds the bookmark at the insertion point. The name must be unique within the document; duplicate names cause runtime error 5941.

Valid Bookmark Names

Bookmark names follow these rules:

Must start with a letter or an underscore
Can contain letters, digits, and underscores
Cannot contain spaces, hyphens, or punctuation
Maximum length is 40 characters
Case-insensitive: “MyBM” and “mybm” are treated as the same name

If you violate these rules, the Add method raises an error. Use a validation routine or sanitize user input before calling Add.

Steps to Add a Bookmark Using VBA

These steps assume you have the Visual Basic Editor open (Alt+F11) and a module inserted. You can write the macro in any module or in the ThisDocument code pane.

Open the VBA Editor
Press Alt+F11 in Word to open the Visual Basic Editor. In the Project Explorer, expand the project that contains your target document. Right-click any module or the ThisDocument object and choose Insert > Module to create a new code module.
Declare a Range variable and set it
Use a Range object to define where the bookmark goes. For example:
Dim rng As Range Set rng = ActiveDocument.Range(Start:=0, End:=100)
This creates a range covering the first 100 characters. To use the current selection, use Set rng = Selection.Range.
Call the Bookmarks.Add method
Write the line that creates the bookmark:
ActiveDocument.Bookmarks.Add Name:="SectionA", Range:=rng
The Name parameter is required. The Range parameter is optional; if you omit it, the bookmark is placed at the insertion point.
Check that the bookmark was added
Use the Exists method to verify:
If ActiveDocument.Bookmarks.Exists("SectionA") Then MsgBox "Bookmark created." End If
This avoids errors if you try to access a bookmark that doesn’t exist.
Handle duplicate names
Before adding a bookmark, check if the name already exists. Delete the old bookmark first or generate a unique name:
Dim bmName As String bmName = "MyBM" If ActiveDocument.Bookmarks.Exists(bmName) Then ActiveDocument.Bookmarks(bmName).Delete End If ActiveDocument.Bookmarks.Add Name:=bmName, Range:=rng

Complete Example Macro

Place this macro in a standard module. It adds a bookmark named “StartOfDoc” at the beginning of the active document.

Sub AddBookmarkAtStart()
    Dim rng As Range
    Set rng = ActiveDocument.Range(Start:=0, End:=0)  ' collapsed range at position 0
    
    If ActiveDocument.Bookmarks.Exists("StartOfDoc") Then
        ActiveDocument.Bookmarks("StartOfDoc").Delete
    End If
    
    ActiveDocument.Bookmarks.Add Name:="StartOfDoc", Range:=rng
    MsgBox "Bookmark 'StartOfDoc' added at the start of the document."
End Sub

Common Problems When Adding Bookmarks With VBA

“Run-time error 5941: The bookmark name is invalid”

This error occurs when the name contains a space, starts with a digit, or exceeds 40 characters. Also occurs if you try to add a bookmark with a name that already exists. Fix: sanitize names with a function that replaces spaces with underscores and truncates to 40 characters. Always check Exists before adding.

Bookmark disappears after saving and reopening

This happens when the bookmark is placed inside a paragraph that gets deleted or when the document is saved in a format that doesn’t support bookmarks (such as plain text .txt). Fix: ensure you save as .docx or .docm. Also check that the Range object points to a stable location. Bookmarks anchored to content that gets removed are lost silently.

Bookmark covers the wrong text

The Range object you pass to Add defines the bookmark’s extent. If you use a collapsed range (start = end), the bookmark marks a point. If you use a range with a length greater than zero, the bookmark covers that text. Fix: verify the Start and End properties of your Range before calling Add. Use Debug.Print rng.Start, rng.End in the Immediate window to inspect.

VBA Bookmark Methods: Add vs Delete vs Exists

Method	Syntax	Behavior
Add	Bookmarks.Add Name, Range	Creates a new bookmark. Returns a Bookmark object. Raises error if name is invalid or duplicate
Delete	Bookmarks(name).Delete	Removes the bookmark but preserves the text. Raises error if bookmark doesn’t exist
Exists	Bookmarks.Exists(name)	Returns True if a bookmark with that name exists, False otherwise. No error if missing

Working With Range vs Selection

When you add a bookmark, you can use either Selection.Range or a Range object you define directly. Both work, but Range is faster and doesn’t move the cursor. Selection requires the user to have the insertion point in the right place. For programmatic automation, always use explicit Range objects.

To bookmark a specific paragraph, use the Paragraphs collection:

Sub BookmarkFirstParagraph()
    Dim rng As Range
    Set rng = ActiveDocument.Paragraphs(1).Range
    rng.End = rng.End - 1  ' exclude paragraph mark
    ActiveDocument.Bookmarks.Add Name:="FirstPara", Range:=rng
End Sub

Conclusion

You can now add bookmarks programmatically using the Bookmarks.Add method with a valid name and a Range object. Always check for existing bookmarks with Exists before adding to avoid runtime errors. Use explicit Range objects instead of Selection for reliable automation. For advanced use, explore the Bookmark.Select method to jump to a bookmark or the Fields.Add method to insert a cross-reference field that points to your new bookmark.

← Back to WiseChecker Home More in Word Solutions