Use DocumentBuilder to inserting a Hyperlink within C# and .NET

In modern documents, hyperlinks play an important role, allowing users to navigate to various resources on the Internet directly from the text of the document. In this article, we will look at how to use the DocumentBuilder component of SautinSoft.Document to insert hyperlinks into documents using C# and .NET.

  1. Add SautinSoft.Document from Nuget.
  2. Create a new document.
  3. Create a Builder based on the document.
  4. Launch InsertHyperlink method.

   Use DocumentBuilderInsertHyperlink method to insert a hyperlink into the document.

inserting a Hyperlink

Download the resulting file in PDF format: Result-insert hyperlink.pdf

Complete code

using System;
using SautinSoft.Document;
using System.Text;
using SautinSoft.Document.Drawing;

namespace Example
{
    class Program
    {
        static void Main(string[] args)
        {
            // Get your free trial key here:   
            // https://sautinsoft.com/start-for-free/
            InsertingHyperlink();
        }
        /// <summary>
        /// Insert a hyperlink into a document using DocumentBuilder.
        /// </summary>
        /// <remarks>
        /// Details: https://www.sautinsoft.com/products/document/help/net/developer-guide/documentbuilder-inserting-hyperlink.php
        /// </remarks>

        static void InsertingHyperlink()
        {
            DocumentCore dc = new DocumentCore();
            DocumentBuilder db = new DocumentBuilder(dc);

            // Insert the formatted text into the document.
            db.CharacterFormat.FontName = "Verdana";
            db.CharacterFormat.Size = 16;
            db.Writeln("Insert a hyperlink into a document using DocumentBuilder.");

            // Inserts a Word field into a document.
            db.CharacterFormat.Size = 26;
            db.CharacterFormat.FontColor = Color.Brown;
            db.InsertField("DATE");
            db.InsertSpecialCharacter(SpecialCharacterType.LineBreak);

            // Insert URL hyperlink.
            db.CharacterFormat.FontColor = Color.Blue;
            db.CharacterFormat.UnderlineStyle = UnderlineType.Dashed;
            db.InsertHyperlink("Welcome to SautinSoft!", "https://sautinsoft.com", false);

            db.InsertSpecialCharacter(SpecialCharacterType.PageBreak);

            // Insert a hyperlink inside a document as a bookmark.
            db.CharacterFormat.FontColor = Color.Brown;
            db.CharacterFormat.UnderlineStyle = UnderlineType.DotDotDash;
            db.InsertHyperlink("back to the field {DATE}", "DATE", true);

            // Save our document into DOCX format.
            string resultPath = @"Result.docx";
            dc.Save(resultPath, new DocxSaveOptions());
			
			// Important for Linux: Install MS Fonts
			// sudo apt install ttf-mscorefonts-installer -y

            // Open the result for demonstration purposes.
            System.Diagnostics.Process.Start(new System.Diagnostics.ProcessStartInfo(resultPath) { UseShellExecute = true });
        }
    }
}

Download

Imports System
Imports SautinSoft.Document
Imports System.Text
Imports SautinSoft.Document.Drawing

Namespace Example
	Friend Class Program
		Shared Sub Main(ByVal args() As String)
			InsertingHyperlink()
		End Sub
                ''' Get your free trial key here:   
                ''' https://sautinsoft.com/start-for-free/
		''' <summary>
		''' Insert a hyperlink into a document using DocumentBuilder.
		''' </summary>
		''' <remarks>
		''' Details: https://www.sautinsoft.com/products/document/help/net/developer-guide/documentbuilder-inserting-hyperlink.php
		''' </remarks>

		Private Shared Sub InsertingHyperlink()
			Dim dc As New DocumentCore()
			Dim db As New DocumentBuilder(dc)

			Dim resultPath As String = "result.docx"

			' Insert the formatted text into the document.
			db.CharacterFormat.FontName = "Verdana"
			db.CharacterFormat.Size = 16
			db.Writeln("Insert a hyperlink into a document using DocumentBuilder.")

			' Inserts a Word field into a document.
			db.CharacterFormat.Size = 26
			db.CharacterFormat.FontColor = Color.Brown
			db.InsertField("DATE")
			db.InsertSpecialCharacter(SpecialCharacterType.LineBreak)

			' Insert URL hyperlink.
			db.CharacterFormat.FontColor = Color.Blue
			db.CharacterFormat.UnderlineStyle = UnderlineType.Dashed
			db.InsertHyperlink("Welcome to SautinSoft!", "https://sautinsoft.com", False)

			db.InsertSpecialCharacter(SpecialCharacterType.PageBreak)

			' Insert a hyperlink inside a document as a bookmark.
			db.CharacterFormat.FontColor = Color.Brown
			db.CharacterFormat.UnderlineStyle = UnderlineType.DotDotDash
			db.InsertHyperlink("back to the field {DATE}", "DATE", True)

			' Save our document into DOCX format.
			dc.Save(resultPath, New DocxSaveOptions())

			' Open the result for demonstration purposes.
			System.Diagnostics.Process.Start(New System.Diagnostics.ProcessStartInfo(resultPath) With {.UseShellExecute = True})
		End Sub
	End Class
End Namespace

Download

If you need a new code example or have a question: email us at support@sautinsoft.com or ask at Online Chat (right-bottom corner of this page) or use the Form below:


Questions and suggestions from you are always welcome!

We are developing .Net components since 2002. We know PDF, DOCX, RTF, HTML, XLSX and Images formats. If you need any assistance with creating, modifying or converting documents in various formats, we can help you. We will write any code example for you absolutely free.