Microsoft Word Add-in Hyperlink Object with VBA code example

Hyperlink

Is a object refers to create link to navigate target location. Hyperlink is very useful object, allows to attach link which can be pointed to other location and upon follow the location can be located. Microsoft Word offers Hyperlinks collection exposed by document object which can be iterated using index (a positive integer). Hyperlink offers various methods and properties as listed below:

ADD

Method can be used to insert or attach a new hyperlink in the document. Below code will select a shape and add hyperlink to it.

Syntax

expression.Add(Ancher, [Address], [SubAddress], [ScreenTip], [TextToDisplay], [Target])

Code example

Public Sub AddHyperLinkIn()
    'Document object
    Dim oDocument As Document
    'bind active document
    Set oDocument = ActiveDocument
    
    'Shape object
    Dim oShape As Shape
    'Bind first shape in the document
    Set oShape = oDocument.Shapes(1)
    
    'Hyperlink object
    Dim hyperLink As hyperLink
    
    'Create new hyperlink
    Set hyperLink = Selection.Hyperlinks.Add(oShape, "https:\\www.vbaoverall.com")
    
    'CleanUp
    If Not oShape Is Nothing Then
        Set oShape = Nothing
    End If
    If Not hyperLink Is Nothing Then
        Set hyperLink = Nothing
    End If
    If Not oDocument Is Nothing Then
        Set oDocument = Nothing
    End If
End Sub

Output

Follow

Method allows to auto navigate target location attached to given object. In this example we will trigger follow method to navigate https://www.vbaoverall.com as shown in above figure using code.

Code example

Public Sub FollowHyperLink()
    'Document object
    Dim oDocument As Document
    'bind active document
    Set oDocument = ActiveDocument
    
    'Shape object
    Dim oShape As Shape
    'Bind first shape in the document
    Set oShape = oDocument.Shapes(1)
    
    'Click on Hyperlink
    oShape.hyperLink.Follow
    
    'CleanUp
    If Not oShape Is Nothing Then
        Set oShape = Nothing
    End If
    If Not oDocument Is Nothing Then
        Set oDocument = Nothing
    End If
End Sub

Output

Count

Is a property, returns available number of hyperlinks in a document. Below code print total number of hyperlinks.

Code example

Public Sub CountHyperlinks()
    'Document object
    Dim oDocument As Document
    'bind active document
    Set oDocument = ActiveDocument
    
    'Print count
    Debug.Print "There are total " & oDocument.Hyperlinks.Count & " hyperlink(s) in your document"
    
     'CleanUp
    If Not oDocument Is Nothing Then
        Set oDocument = Nothing
    End If
End Sub

Output

There are total 1 hyperlink(s) in your document

Hyperlinks

Is a collection contains all available hyperlinks in a document. Below code prints address of all available hyperlinks using for each loop.

Code example

Public Sub ListAllHyperLinks()
    'Document object
    Dim oDocument As Document
    'bind active document
    Set oDocument = ActiveDocument
    
    'Object for hyperlink
    Dim oHyperLink As hyperLink
    
    'Iterate each hyperlink
    For Each oHyperLink In oDocument.Hyperlinks
        Debug.Print oHyperLink.Address
    Next oHyperLink
    
    'CleanUp
    If Not oDocument Is Nothing Then
        Set oDocument = Nothing
    End If
    If Not oHyperLink Is Nothing Then
        Set oHyperLink = Nothing
    End If
End Sub

Output

https://www.vbaoverall.com

Next >> Microsoft Word Frame Object with VBA code example

Share on Facebook

VBA Basic and Advanced Questions and Answers

Basic Q&A Q. VBA stands for? Ans: Visual Basic for Applications Q. What is VBA? Ans: VBA (Visual Basic for Applications) is a scripting language. It can be used to automate most of the Microsoft Office Applications like Excel, Word, PowerPoint, MS Access, Outlook etc. Q. Types of available modules in VBA VBA contains four […]

Export Generic Collection to PDF ASP.Net Core MVC

PDF Sometime you may in need to export data in PDF. Following code will use Syncfusion Package and give you ready made Table pushed from Generic collection. Put below code in Repository Put below code in Controller JavaScript Code Finally you can attach id to an element in html and in JavaScript on Document ready […]

Export Excel ASP.Net Core MVC

Excel Export Following Example helps you to export excel from database in a generic way using EPPlus library. Requirement EPPlus Nuget Package Code to Repository Supporting Method Code to Controller Code to JavaScript JavaScript Supporting Method You can hit ExportToExcel() call in document ready method in JavaScript document by pointing any id written in HTML […]

Save/Retrieve Session ASP.Net Core MVC

Session Plays a vital role while dealing with caching in your browser. ASP.Net Core offers Session caching fast and reliable way. Here is the practical example. Put following code anywhere in common class or Repository, it has two methods Generic in nature Add/Get. Add Method will allow you to cache object in Browser memory and […]

Number List in Word Document using C# code example

Number List Microsoft Word offers feature by which you can auto number your list in various formats. In this article we will write code to dynamically generate a numbered list in a document using C#. C# Code example Note: You have to add Microsoft Word Interop library as reference to enable Using statement or create […]

Sorting in Microsoft Word using VBA (Visual Basic for Applications)

Sorting Do you know, Microsoft Word has capability to perform sorting over a document. In this article we will write code to sort paragraphs in Alphabetical order using visual basic for applications code. Before code Code example Put above code in a module, Select number of paragraphs that you would like to sort in A-Z […]

EPPlus Open Office Xml Office solution using C#

EPPlus Is an open Office XML solution, highly useful library capable to manipulate Microsoft Excel similar to Introp APIs. Why EPPlus? As per Microsoft the solutions (Excel, Word, PowerPoint, Outlook etc) built for client architecture but what about Servers? Let’s take an example that I have recently faced and EPPlus helped me a lot here. […]

String vs StringBuilder C#.Net with code example

String C# class which offers capability to store any type of string data into a variable. Strings are immutable (non-modifiable) cause performance overhead because each time we modify a string it creates a copy of modified instance into the memory, hence, as a practice string should be avoided for large string operations. Following is the […]

Var vs. Dynamic C# with code example

Var vs. Dynamic C# offers variety with flavors to accomplish the task to the developers. var keyword defines a static nature which gets resolve at compile-time introduced in C# 3.0 where dynamic gets resolved at runtime introduced in C# 4.0. Var is a statically type variable, which means values of these variables gets decoded at […]

Multi-threading in C#.Net with step by step code example

Multi-threading Is a concept to execute multiple tasks or process simultaneously. Basically multi-threading enables paths to your application to execute multiple processes. Multi-threading can be achieved in C# using System.Threading name space which provides complete control over threading. Let’s write example code where we will execute two different methods to print numbers using loop and […]

Microsoft Word Add-in Hyperlink Object with VBA code example

Hyperlink

ADD

Syntax

Code example

Output

Follow

Code example

Output

Count

Code example

Output

Hyperlinks

Code example

Output

Leave a Reply Cancel reply

Sorting in Microsoft Word using VBA (Visual Basic for Applications)

Create a progress bar in Excel using VBA (Visual Basic for Applications)

Get Count of Cells based on Color Excel Add-in using VBA

Auto Reply in Outlook Add-in using VBA code example

Filter Meetings in Outlook Add-in using Visual Basic for Applications

RSS feed

Subscribe to our articles