This patch adds basic support for inserting and manipulating bookmarks inside a word file. It also allows for inserting text at bookmark locations. The change was predicated on a need to insert text at bookmark locations in a sort of token replacement.

Patch provided by Simon Timms

DocX/Container.cs

@@ -1,10 +1,10 @@
 using System;
-using System.Collections.Generic;
 using System.IO;
-using System.IO.Packaging;
 using System.Linq;
-using System.Text.RegularExpressions;
 using System.Xml.Linq;
+using System.IO.Packaging;
+using System.Collections.Generic;
+using System.Text.RegularExpressions;
 
 namespace Novacode
 {
@@ -387,6 +387,27 @@ namespace Novacode
                         p.ReplaceText(oldValue, newValue, trackChanges, options, newFormatting, matchFormatting, fo);
         }
 
+        public virtual void InsertAtBookmark(string toInsert, string bookmarkName)
+        {
+            if (String.IsNullOrWhiteSpace(bookmarkName))
+                throw new ArgumentException("bookmark cannot be null or empty", "bookmarkName");
+
+            var headerCollection = Document.Headers;
+            var headers = new List<Header> { headerCollection.first, headerCollection.even, headerCollection.odd };
+            foreach (var header in headers.Where(x => x != null))
+                foreach (var paragraph in header.Paragraphs)
+                    paragraph.InsertAtBookmark(toInsert, bookmarkName);
+
+            foreach (var paragraph in Paragraphs)
+                paragraph.InsertAtBookmark(toInsert, bookmarkName);
+
+            var footerCollection = Document.Footers;
+            var footers = new List<Footer> { footerCollection.first, footerCollection.even, footerCollection.odd };
+            foreach (var footer in footers.Where(x => x != null))
+                foreach (var paragraph in footer.Paragraphs)
+                    paragraph.InsertAtBookmark(toInsert, bookmarkName);
+        }
+
         public virtual Paragraph InsertParagraph(int index, string text, bool trackChanges)
         {
             return InsertParagraph(index, text, trackChanges, null);
@@ -672,6 +693,13 @@ namespace Novacode
             return p;
         }
 
+        public virtual Paragraph InsertBookmark(String bookmarkName)
+        {
+            var p = InsertParagraph();
+            p.AppendBookmark(bookmarkName);
+            return p;
+        }
+
         public virtual Table InsertTable(int rowCount, int columnCount) //Dmitchern, changed to virtual, and overrided in Table.Cell
         {
             XElement newTable = HelperFunctions.CreateTable(rowCount, columnCount);

DocX/DocX.csproj

@@ -10,7 +10,7 @@
     <AppDesignerFolder>Properties</AppDesignerFolder>
     <RootNamespace>Novacode</RootNamespace>
     <AssemblyName>DocX</AssemblyName>
-    <TargetFrameworkVersion>v3.5</TargetFrameworkVersion>
+    <TargetFrameworkVersion>v4.0</TargetFrameworkVersion>
     <FileAlignment>512</FileAlignment>
     <SccProjectName>SAK</SccProjectName>
     <SccLocalPath>SAK</SccLocalPath>
@@ -87,6 +87,7 @@
     </Reference>
   </ItemGroup>
   <ItemGroup>
+    <Compile Include="Bookmark.cs" />
     <Compile Include="Border.cs" />
     <Compile Include="Charts\Axis.cs" />
     <Compile Include="Charts\BarChart.cs" />

DocX/Paragraph.cs

@@ -1,14 +1,14 @@
 using System;
-using System.Collections;
-using System.Collections.Generic;
-using System.Drawing;
-using System.Globalization;
 using System.IO;
-using System.IO.Packaging;
 using System.Linq;
+using System.Drawing;
+using System.Xml.Linq;
+using System.Collections;
+using System.IO.Packaging;
+using System.Globalization;
 using System.Security.Principal;
+using System.Collections.Generic;
 using System.Text.RegularExpressions;
-using System.Xml.Linq;
 
 
 namespace Novacode
@@ -37,25 +37,25 @@ namespace Novacode
         {
             get
             {
-              return ParagraphNumberPropertiesBacker ?? (ParagraphNumberPropertiesBacker = GetParagraphNumberProperties());
+                return ParagraphNumberPropertiesBacker ?? (ParagraphNumberPropertiesBacker = GetParagraphNumberProperties());
             }
         }
 
-      private XElement GetParagraphNumberProperties()
-      {
-        var numPrNode = Xml.Descendants().FirstOrDefault(el => el.Name.LocalName == "numPr");
-        if (numPrNode != null)
+        private XElement GetParagraphNumberProperties()
         {
-          var numIdNode = numPrNode.Descendants().First(numId => numId.Name.LocalName == "numId");
-          var numIdAttribute = numIdNode.Attribute(DocX.w + "val");
-          if (numIdAttribute != null && numIdAttribute.Value.Equals("0"))
-          {
-            return null;
-          }
-        }
+            var numPrNode = Xml.Descendants().FirstOrDefault(el => el.Name.LocalName == "numPr");
+            if (numPrNode != null)
+            {
+                var numIdNode = numPrNode.Descendants().First(numId => numId.Name.LocalName == "numId");
+                var numIdAttribute = numIdNode.Attribute(DocX.w + "val");
+                if (numIdAttribute != null && numIdAttribute.Value.Equals("0"))
+                {
+                    return null;
+                }
+            }
 
-        return numPrNode;
-      }
+            return numPrNode;
+        }
 
         private bool? IsListItemBacker { get; set; }
         /// <summary>
@@ -988,7 +988,7 @@ namespace Novacode
         {
             // Convert the path of this mainPart to its equilivant rels file path.
             string path = mainPart.Uri.OriginalString.Replace("/word/", "");
-            Uri rels_path = new Uri("/word/_rels/" + path + ".rels", UriKind.Relative);
+            Uri rels_path = new Uri(String.Format("/word/_rels/{0}.rels", path), UriKind.Relative);
 
             // Check to see if the rels file exists and create it if not.
             if (!Document.package.PartExists(rels_path))
@@ -1385,16 +1385,16 @@ namespace Novacode
             // Returns the underlying XElement's Value property.
             get
             {
-              try
-              {
-                return HelperFunctions.GetFormattedText(Xml);
-
-              }
-              catch (Exception)
-              {
-                return null;
-              }            
-            
+                try
+                {
+                    return HelperFunctions.GetFormattedText(Xml);
+
+                }
+                catch (Exception)
+                {
+                    return null;
+                }
+
             }
         }
 
@@ -2228,6 +2228,48 @@ namespace Novacode
             return this;
         }
 
+        public Paragraph AppendBookmark(String bookmarkName)
+        {
+            XElement wBookmarkStart = new XElement(
+                XName.Get("bookmarkStart", DocX.w.NamespaceName),
+                new XAttribute(XName.Get("id", DocX.w.NamespaceName), 0),
+                new XAttribute(XName.Get("name", DocX.w.NamespaceName), bookmarkName));
+            Xml.Add(wBookmarkStart);
+
+            XElement wBookmarkEnd = new XElement(
+                XName.Get("bookmarkEnd", DocX.w.NamespaceName),
+                new XAttribute(XName.Get("id", DocX.w.NamespaceName), 0),
+                new XAttribute(XName.Get("name", DocX.w.NamespaceName), bookmarkName));
+            Xml.Add(wBookmarkEnd);
+
+            return this;
+        }
+
+        public IEnumerable<Bookmark> GetBookmarks()
+        {
+            return Xml.Descendants(XName.Get("bookmarkStart", DocX.w.NamespaceName))
+                        .Select(x => x.Attribute(XName.Get("name", DocX.w.NamespaceName)))
+                        .Select(x => new Bookmark
+                        {
+                            Name = x.Value,
+                            Paragraph = this
+                        });
+        }
+
+        public void InsertAtBookmark(string toInsert, string bookmarkName)
+        {
+            var bookmark = Xml.Descendants(XName.Get("bookmarkStart", DocX.w.NamespaceName))
+                                .Where(x => x.Attribute(XName.Get("name", DocX.w.NamespaceName)).Value == bookmarkName).SingleOrDefault();
+            if (bookmark != null)
+            {
+                
+                var run = HelperFunctions.FormatInput(toInsert, null);
+                bookmark.AddBeforeSelf(run);
+                runs = Xml.Elements(XName.Get("r", DocX.w.NamespaceName)).ToList();
+                HelperFunctions.RenumberIDs(Document);
+            }
+        }
+
         internal string GetOrGenerateRel(Picture p)
         {
             string image_uri_string = p.img.pr.TargetUri.OriginalString;
@@ -2386,17 +2428,17 @@ namespace Novacode
                     p_xml = (XElement)run.Xml.NextNode;
                 }
             }
-                // Extract the attribute id from the Pictures Xml.
-                XAttribute a_id =
-                (
-                    from e in p_xml.Descendants()
-                    where e.Name.LocalName.Equals("blip")
-                    select e.Attribute(XName.Get("embed", "http://schemas.openxmlformats.org/officeDocument/2006/relationships"))
-                ).Single();
+            // Extract the attribute id from the Pictures Xml.
+            XAttribute a_id =
+            (
+                from e in p_xml.Descendants()
+                where e.Name.LocalName.Equals("blip")
+                select e.Attribute(XName.Get("embed", "http://schemas.openxmlformats.org/officeDocument/2006/relationships"))
+            ).Single();
+
+            // Set its value to the Pictures relationships id.
+            a_id.SetValue(Id);
 
-                // Set its value to the Pictures relationships id.
-                a_id.SetValue(Id);
-            
 
             return this;
         }
@@ -2472,15 +2514,15 @@ namespace Novacode
                 return;
             }
 
-          var contentIsListOfFontProperties = false;
-          var fontProps = content as IEnumerable;
-          if (fontProps != null)
-          {
-            foreach (object property in fontProps)
+            var contentIsListOfFontProperties = false;
+            var fontProps = content as IEnumerable;
+            if (fontProps != null)
             {
-              contentIsListOfFontProperties = (property as XAttribute != null);
+                foreach (object property in fontProps)
+                {
+                    contentIsListOfFontProperties = (property as XAttribute != null);
+                }
             }
-          }
 
             foreach (XElement run in runs)
             {
@@ -2494,21 +2536,21 @@ namespace Novacode
                 rPr.SetElementValue(textFormatPropName, value);
                 XElement last = rPr.Elements().Last();
 
-              if (contentIsListOfFontProperties) //if content is a list of attributes, as in the case when specifying a font family 
-              {
-                foreach (object property in fontProps)
+                if (contentIsListOfFontProperties) //if content is a list of attributes, as in the case when specifying a font family 
                 {
-                  if (last.Attribute(((System.Xml.Linq.XAttribute) (property)).Name) == null)
-                  {
-                    last.Add(property); //Add this attribute if element doesn't have it
-                  }
-                  else
-                  {
-                    last.Attribute(((System.Xml.Linq.XAttribute) (property)).Name).Value =
-                      ((System.Xml.Linq.XAttribute) (property)).Value; //Apply value only if element already has it
-                  }
+                    foreach (object property in fontProps)
+                    {
+                        if (last.Attribute(((System.Xml.Linq.XAttribute)(property)).Name) == null)
+                        {
+                            last.Add(property); //Add this attribute if element doesn't have it
+                        }
+                        else
+                        {
+                            last.Attribute(((System.Xml.Linq.XAttribute)(property)).Name).Value =
+                              ((System.Xml.Linq.XAttribute)(property)).Value; //Apply value only if element already has it
+                        }
+                    }
                 }
-              }
 
                 if (content as System.Xml.Linq.XAttribute != null)//If content is an attribute
                 {
@@ -3068,7 +3110,7 @@ namespace Novacode
             }
         }
 
-                
+
         /// <summary>
         /// Set the linespacing for this paragraph manually.
         /// </summary>
@@ -3077,8 +3119,8 @@ namespace Novacode
         public void SetLineSpacing(LineSpacingType spacingType, float spacingFloat)
         {
             spacingFloat = spacingFloat * 240;
-            int spacingValue = (int) spacingFloat;
-            
+            int spacingValue = (int)spacingFloat;
+
             var pPr = this.GetOrCreate_pPr();
             var spacing = pPr.Element(XName.Get("spacing", DocX.w.NamespaceName));
             if (spacing == null)
@@ -3086,31 +3128,31 @@ namespace Novacode
                 pPr.Add(new XElement(XName.Get("spacing", DocX.w.NamespaceName)));
                 spacing = pPr.Element(XName.Get("spacing", DocX.w.NamespaceName));
             }
-            
+
             string spacingTypeAttribute = "";
             switch (spacingType)
             {
-            	case LineSpacingType.Line:
-            		{
-            			spacingTypeAttribute = "line";
-            			break;
-            		}
-            	case LineSpacingType.Before:
-            		{
-            			spacingTypeAttribute = "before";
-            			break;
-            		}
-            	case LineSpacingType.After:
-            		{
-            			spacingTypeAttribute = "after";
-            			break;
-            		}          		
-            		
+                case LineSpacingType.Line:
+                    {
+                        spacingTypeAttribute = "line";
+                        break;
+                    }
+                case LineSpacingType.Before:
+                    {
+                        spacingTypeAttribute = "before";
+                        break;
+                    }
+                case LineSpacingType.After:
+                    {
+                        spacingTypeAttribute = "after";
+                        break;
+                    }
+
             }
-            
+
             spacing.SetAttributeValue(XName.Get(spacingTypeAttribute, DocX.w.NamespaceName), spacingValue);
         }
-        
+
         /// <summary>
         /// Set the linespacing for this paragraph using the Auto value.
         /// </summary>
@@ -3118,58 +3160,59 @@ namespace Novacode
         public void SetLineSpacing(LineSpacingTypeAuto spacingType)
         {
             int spacingValue = 100;
-            
+
             var pPr = this.GetOrCreate_pPr();
             var spacing = pPr.Element(XName.Get("spacing", DocX.w.NamespaceName));
-            
+
             if (spacingType.Equals(LineSpacingTypeAuto.None))
             {
-            	if (spacing != null)
-            	{
-            		spacing.Remove();
-            	}
+                if (spacing != null)
+                {
+                    spacing.Remove();
+                }
             }
-            
-            else {
-            	
-	            if (spacing == null)
-	            {
-	                pPr.Add(new XElement(XName.Get("spacing", DocX.w.NamespaceName)));
-	                spacing = pPr.Element(XName.Get("spacing", DocX.w.NamespaceName));
-	            }
-	            
-	            string spacingTypeAttribute = "";
-	            string autoSpacingTypeAttribute = "";
-	            switch (spacingType)
-	            {
-	            	case LineSpacingTypeAuto.AutoBefore:
-	            		{
-	            			spacingTypeAttribute = "before";
-	            			autoSpacingTypeAttribute = "beforeAutospacing";
-	            			break;
-	            		}
-	            	case LineSpacingTypeAuto.AutoAfter:
-	            		{
-	            			spacingTypeAttribute = "after";
-	            			autoSpacingTypeAttribute = "afterAutospacing";
-	            			break;
-	            		}
-	            	case LineSpacingTypeAuto.Auto:
-	            		{
-	            			spacingTypeAttribute = "before";
-	            			autoSpacingTypeAttribute = "beforeAutospacing";
-	            			spacing.SetAttributeValue(XName.Get("after", DocX.w.NamespaceName), spacingValue);
-	            			spacing.SetAttributeValue(XName.Get("afterAutospacing", DocX.w.NamespaceName), 1);
-	            			break;
-	            		}            		
-	            		
-	            }
-	            
-	            spacing.SetAttributeValue(XName.Get(autoSpacingTypeAttribute, DocX.w.NamespaceName), 1);
-	            spacing.SetAttributeValue(XName.Get(spacingTypeAttribute, DocX.w.NamespaceName), spacingValue);            	
-            	
+
+            else
+            {
+
+                if (spacing == null)
+                {
+                    pPr.Add(new XElement(XName.Get("spacing", DocX.w.NamespaceName)));
+                    spacing = pPr.Element(XName.Get("spacing", DocX.w.NamespaceName));
+                }
+
+                string spacingTypeAttribute = "";
+                string autoSpacingTypeAttribute = "";
+                switch (spacingType)
+                {
+                    case LineSpacingTypeAuto.AutoBefore:
+                        {
+                            spacingTypeAttribute = "before";
+                            autoSpacingTypeAttribute = "beforeAutospacing";
+                            break;
+                        }
+                    case LineSpacingTypeAuto.AutoAfter:
+                        {
+                            spacingTypeAttribute = "after";
+                            autoSpacingTypeAttribute = "afterAutospacing";
+                            break;
+                        }
+                    case LineSpacingTypeAuto.Auto:
+                        {
+                            spacingTypeAttribute = "before";
+                            autoSpacingTypeAttribute = "beforeAutospacing";
+                            spacing.SetAttributeValue(XName.Get("after", DocX.w.NamespaceName), spacingValue);
+                            spacing.SetAttributeValue(XName.Get("afterAutospacing", DocX.w.NamespaceName), 1);
+                            break;
+                        }
+
+                }
+
+                spacing.SetAttributeValue(XName.Get(autoSpacingTypeAttribute, DocX.w.NamespaceName), 1);
+                spacing.SetAttributeValue(XName.Get(spacingTypeAttribute, DocX.w.NamespaceName), spacingValue);
+
             }
- 
+
         }
 
 

Examples/Program.cs

@@ -24,6 +24,7 @@ namespace Examples
             HyperlinksImagesTables();
             AddList();
             Equations();
+            Bookmarks();
             BarChart();
             PieChart();
             LineChart();
@@ -215,6 +216,25 @@ namespace Examples
             }
         }
 
+        private static void Bookmarks()
+        {
+            Console.WriteLine("\nBookmarks()");
+
+            using (var document = DocX.Create(@"docs\Bookmarks.docx"))
+            {
+                var paragraph = document.InsertBookmark("firstBookmark");
+
+                var paragraph2 = document.InsertParagraph("This is a paragraph which contains a ");
+                paragraph2.AppendBookmark("secondBookmark");
+                paragraph2.Append("bookmark");
+
+                paragraph2.InsertAtBookmark("handy ", "secondBookmark");
+
+                document.Save();
+                Console.WriteLine("\tCreated: docs\\Bookmarks.docx\n");
+            
+            }
+        }
         /// <summary>
         /// Create a document with a Paragraph whos first line is indented.
         /// </summary>

UnitTests/DocXUnitTests.cs

@@ -1,13 +1,13 @@
 using System;
-using System.Collections.Generic;
-using System.Drawing;
+using Novacode;
 using System.IO;
 using System.Linq;
+using System.Drawing;
+using System.Xml.Linq;
 using System.Reflection;
+using System.Collections.Generic;
 using System.Text.RegularExpressions;
-using System.Xml.Linq;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
-using Novacode;
 
 namespace UnitTests
 {

UnitTests/UnitTests.csproj

@@ -63,6 +63,12 @@
     </CodeAnalysisDependentAssemblyPaths>
   </ItemGroup>
   <ItemGroup>
+    <Compile Include="InsertAtBookmark.cs">
+      <DependentUpon>DocXUnitTests.cs</DependentUpon>
+    </Compile>
+    <Compile Include="AppendBookmark.cs">
+      <DependentUpon>DocXUnitTests.cs</DependentUpon>
+    </Compile>
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="DocXUnitTests.cs" />
     <Compile Include="RelativeDirectory.cs" />
@@ -98,11 +104,11 @@
     </ProjectReference>
   </ItemGroup>
   <Import Project="$(MSBuildBinPath)\Microsoft.CSharp.targets" />
-  <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 
-       Other similar extension points exist, see Microsoft.Common.targets.
-  <Target Name="BeforeBuild">
-  </Target>
-  <Target Name="AfterBuild">
-  </Target>
+  <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 
+       Other similar extension points exist, see Microsoft.Common.targets.
+  <Target Name="BeforeBuild">
+  </Target>
+  <Target Name="AfterBuild">
+  </Target>
   -->
 </Project>