Articles in this section
Category / Section

How to replace the particular text with hyperlink in Word document?

4 mins read

Syncfusion Essential DocIO is a .NET Word library used to create, read, and edit Word documents programmatically without Microsoft Word or interop dependencies. Using this library, you can replace the particular text with hyperlink in C# and VB.NET.

Replace the particular text with hyperlink using C#:

  1. Create a new C# console application project.Create Console application in Visual Studio
  2. Install Syncfusion.DocIO.WinForms NuGet package as a reference to your .NET Framework applications from the DocIO NuGet package reference to the project
  3. Include the following namespace in the Program.cs file.


using Syncfusion.DocIO.DLS;


Imports Syncfusion.DocIO.DLS
  1. Use the following code example to replace the particular text with hyperlink.


//Opens the template document
using (WordDocument document = new WordDocument("Template.docx", FormatType.Docx))
    string textToReplace = "Syncfusion";
    //Initializes text body part
    TextBodyPart textBodyPart = new TextBodyPart(document);
    //Initialize new paragraph
    WParagraph paragraph = new WParagraph(document);
    //Adds new paragraph to the text body part
    //Appends web hyperlink to the paragraph
    paragraph.AppendHyperlink("", textToReplace, HyperlinkType.WebLink);
    //Replaces all entries of given string in the document with text body part
    document.Replace(textToReplace, textBodyPart, false, true);
    //Clears the text body part
    //Saves the Word document


'Opens the template document
Using document As WordDocument = New WordDocument("Template.docx", FormatType.Docx)
    Dim textToReplace As String = "Syncfusion"
    'Initializes text body part
    Dim textBodyPart As TextBodyPart = New TextBodyPart(document)
    'Initializes new paragraph
    Dim paragraph As WParagraph = New WParagraph(document)
    'Adds new paragraph to the text body part
    'Replaces all entries of given string in the document with text body part
    paragraph.AppendHyperlink("", textToReplace, HyperlinkType.WebLink)
    'Clears the text body part
    'Saves the Word document
End Using

A complete working example to replace the particular text with hyperlink using C# can be downloaded from Replace text with hyperlink.

By executing the application, you will get the output Word document as follows. Replaced text with hyperlink in Word document in C# using DocIO

Take a moment to peruse the documentation, where you can find basic Word document processing options along with features like mail merge, merge and split documents, find and replace text in the Word document, protect the Word documents, and most importantly PDF and Image conversions with code examples.

Explore more about the rich set of Syncfusion Word Framework features.


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 link to learn about generating and registering Syncfusion license key in your application to use the components without trail message.


Did you find this information helpful?
Help us improve this page
Please provide feedback or comments
Comments (0)
Please sign in to leave a comment