Click or drag to resize

DocumentBuilderInsertHyperlink Method

Inserts a hyperlink into the document.

Namespace: SautinSoft.Document
Assembly: SautinSoft.Document (in SautinSoft.Document.dll) Version: 2024.3.11
Syntax
public Hyperlink InsertHyperlink(
	string displayText,
	string urlOrBookmark,
	bool isBookmark
)

Parameters

displayText  String
Text of the link to be displayed in the document.
urlOrBookmark  String
Link destination. Can be a url or a name of a bookmark inside the document.
isBookmark  Boolean
True if the previous parameter is a name of a bookmark inside the document; false is the previous parameter is a URL.

Return Value

Hyperlink
Hyperlink that was just inserted.
Example

See Developer Guide: How to insert a hyperlink into a document using DocumentBuilder

How to insert a hyperlink into a document using DocumentBuilder in C#
using System;
using SautinSoft.Document;
using System.Text;
using SautinSoft.Document.Drawing;

namespace Example
{
    class Program
    {
        static void Main(string[] args)
        {
            // Get your free 30-day 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 });
        }
    }
}
How to insert a hyperlink into a document using DocumentBuilder in VB.Net
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 30-day 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
See Also