Click or drag to resize

Hyperlink Class

Represents a hyperlink.
Inheritance Hierarchy
SystemObject
  SautinSoft.DocumentElement
    SautinSoft.DocumentInline
      SautinSoft.DocumentHyperlink

Namespace: SautinSoft.Document
Assembly: SautinSoft.Document (in SautinSoft.Document.dll) Version: 2024.3.11
Syntax
public sealed class Hyperlink : Inline, 
	IContentElement

The Hyperlink type exposes the following members.

Constructors
 NameDescription
Public methodCode exampleHyperlink(DocumentCore, String, Inline) Initializes a new instance of the Hyperlink class.
Public methodCode exampleHyperlink(DocumentCore, String, IEnumerableInline) Initializes a new instance of the Hyperlink class.
Public methodCode exampleHyperlink(DocumentCore, String, String) Initializes a new instance of the Hyperlink class.
Top
Properties
 NameDescription
Public propertyCode exampleAddress Gets or sets the hyperlink address.
Public propertyCode exampleDisplayInlines Gets the hyperlink display Inlines.
Public propertyElementType Gets the ElementType of this element instance.
(Overrides ElementElementType)
Public propertyIsBookmarkLink Gets or sets a value indicating whether this Hyperlink instance is bookmark link.
Public propertyCode exampleScreenTip Gets or sets the screen tip.
Public propertyTargetFrame Gets or sets the target frame.
Top
Methods
 NameDescription
Public methodClone Clones this Hyperlink instance, and optionally clones it's display elements.
Top
Example

See Developer Guide: How to add a hyperlink into a document

How to add a hyperlink into a document in C#
using SautinSoft.Document;

namespace Sample
{
    class Sample
    {
        static void Main(string[] args)
        {
            // Get your free 30-day key here:   
            // https://sautinsoft.com/start-for-free/

            AddHyperlink();
        }

        /// <summary>
        /// How to add a hyperlink into a document. 
        /// </summary>
        /// <remarks>
        /// Details: https://sautinsoft.com/products/document/help/net/developer-guide/hyperlinks.php
        /// </remarks>        
        public static void AddHyperlink()
        {
            string docxPath = @"Hyperlink.docx";

            // Let's create a simple DOCX document with a hyperlink.
            DocumentCore dc = new DocumentCore();

            Hyperlink hpl = new Hyperlink(dc, "http://www.zoo.org", "Welcome to Zoo!");
            (hpl.DisplayInlines[0] as Run).CharacterFormat = new CharacterFormat() { Size = 16, FontColor = new Color("#358CCB"), UnderlineStyle = UnderlineType.Single };
            hpl.ScreenTip = "Welcome to WoodLand Zoo!";

            Paragraph p = new Paragraph(dc);
            p.Inlines.Add(hpl);
            p.ParagraphFormat.Alignment = HorizontalAlignment.Center;

            dc.Content.Start.Insert(p.Content);

            // Save our document to DOCX format.
            dc.Save(docxPath);

           // Open the result for demonstration purposes.
            System.Diagnostics.Process.Start(new System.Diagnostics.ProcessStartInfo(docxPath) { UseShellExecute = true });
        }
    }
}
How to add a hyperlink into a document in VB.Net
Imports System
Imports System.IO
Imports SautinSoft.Document

Module Sample
    Sub Main()
        AddHyperlink()
    End Sub
    ''' Get your free 30-day key here:   
    ''' https://sautinsoft.com/start-for-free/
    ''' <summary>
    ''' How to add a hyperlink into a document. 
    ''' </summary>
    ''' <remarks>
    ''' Details: https://sautinsoft.com/products/document/help/net/developer-guide/hyperlinks.php
    ''' </remarks>        
    Sub AddHyperlink()
        Dim docxPath As String = "Hyperlink.docx"

        ' Let's create a simple DOCX document with a hyperlink.
        Dim dc As New DocumentCore()

        Dim hpl As New Hyperlink(dc, "http://www.zoo.org", "Welcome to Zoo!")
        TryCast(hpl.DisplayInlines(0), Run).CharacterFormat = New CharacterFormat() With {
            .Size = 16,
            .FontColor = New Color("#358CCB"),
            .UnderlineStyle = UnderlineType.Single
        }
        hpl.ScreenTip = "Welcome to WoodLand Zoo!"

        Dim p As New Paragraph(dc)
        p.Inlines.Add(hpl)
        p.ParagraphFormat.Alignment = HorizontalAlignment.Center

        dc.Content.Start.Insert(p.Content)

        ' Save our document to DOCX format.
        dc.Save(docxPath)

        ' Open the result for demonstration purposes.
        System.Diagnostics.Process.Start(New System.Diagnostics.ProcessStartInfo(docxPath) With {.UseShellExecute = True})
    End Sub
End Module
See Also