How to Insert HTML Within Bookmark in a Core Word Document?
Syncfusion® Essential® DocIO is a .NET Word library used to create, read, edit, and convert Word documents programmatically without Microsoft Word or interop dependencies. Using this library, you can insert HTML within bookmark in a Word document using C#.
Steps to insert HTML within bookmark in a Word document:
- Create a new .NET Core console application project.
- Install the Syncfusion.DocIO.Net.Core NuGet package as a reference to your project from NuGet.org.
Starting with v16.2.0.x, if you reference Syncfusion® assemblies from trial setup or from the NuGet feed, include a license key in your projects. Refer to the link to learn about generating and registering a Syncfusion® license key in your application to use the components without trail message.
- Include the following namespaces in Program.cs file
C#
using Syncfusion.DocIO.DLS;
- Use the following code example to insert HTML within bookmark in a Word document.
C#
using (WordDocument document = new WordDocument())
{
//Initialize the paragraph where the bookmark will be inserted.
IWParagraph paragraph = null;
//Get the full path of the input HTML file.
string htmlPage = Path.GetFullPath(@"Data/Input.html");
//Read the HTML content from the input file.
string htmlContent = File.ReadAllText(htmlPage);
//Add a new section to the Word document.
IWSection section = document.AddSection();
//Add a paragraph to the section.
paragraph = section.AddParagraph();
//Insert a bookmark start at the current location in the paragraph.
paragraph.AppendBookmarkStart("Index");
//Insert a bookmark end at the current location in the paragraph.
paragraph.AppendBookmarkEnd("Index");
//Convert the HTML content into a WordDocumentPart.
WordDocumentPart htmlDocumentPart = ConvertHTMLToWordDocumentPart(htmlContent);
//Create an instance of BookmarksNavigator to navigate to the bookmark.
BookmarksNavigator bookmarkNavigator = new BookmarksNavigator(document);
//Move the virtual cursor to the location of the bookmark named "Index".
bookmarkNavigator.MoveToBookmark("Index");
//Replace the bookmark content with the converted HTML content.
bookmarkNavigator.ReplaceContent(htmlDocumentPart);
//Close htmlDocumentPart.
htmlDocumentPart.Close();
//Save the modified document to a specified file path in DOCX format.
using (FileStream outputStream = new FileStream(Path.GetFullPath("Output/Output.docx"), FileMode.Create, FileAccess.Write))
{
document.Save(outputStream, Syncfusion.DocIO.FormatType.Docx);
}
}
- Use the following helper method to convert an HTML string into a WordDocumentPart to be inserted into the Word document.
C#
/// <summary>
/// Converts an HTML string into a WordDocumentPart to be inserted into the Word document.
/// </summary>
static WordDocumentPart ConvertHTMLToWordDocumentPart(string html)
{
//Create a new Word document.
WordDocument tempDocument = new WordDocument();
//Add minimal content to the document (ensures the document structure is valid).
tempDocument.EnsureMinimal();
//Append the HTML string to the last paragraph of the temporary Word document.
tempDocument.LastParagraph.AppendHTML(html);
//Create a new WordDocumentPart instance.
WordDocumentPart wordDocumentPart = new WordDocumentPart();
//Load the temporary document into the WordDocumentPart.
wordDocumentPart.Load(tempDocument);
//Return the WordDocumentPart containing the converted HTML content.
return wordDocumentPart;
}
You can download a complete working sample to insert HTML within bookmark in a Word document from the GitHub.
By executing the program, you will get the Word document as follows.
Take a moment to peruse the documentation where you can find basic Word document processing options along with the features like mail merge, merge, split, and compare Word documents, find and replace text in the Word document, protect the Word documents, and most importantly, the PDF and Image conversions with code examples.
Conclusion
I hope you enjoyed learning about how to insert HTML within bookmark in a Core Word document.
You can refer to our ASP.NET Core DocIO feature tour page to know about its other groundbreaking feature representations and documentation, and how to quickly get started for configuration specifications. You can also explore our ASP.NET Core DocIO example to understand how to create and manipulate data.
For current customers, you can check out our components from the License and Downloads page. If you are new to Syncfusion®, you can try our 30-day free trial to check out our other controls.
If you have any queries or require clarifications, please let us know in the comments section below. You can also contact us through our support forums, Direct-Trac, or feedback portal. We are always happy to assist you!