InsertHyperlink Method

Inserts a hyperlink to an external resource such as a website.

Syntax

Visual Basic

'Declaration
 
Public Function InsertHyperlink( _
   ByVal documentOffset As Integer, _
   ByVal targetUri As String, _
   ByRef error As String, _
   Optional ByVal displayText As String, _
   Optional ByVal tooltip As String _
) As HyperlinkNode

C#

public HyperlinkNode InsertHyperlink( 
   int documentOffset,
   string targetUri,
   out string error,
   string displayText,
   string tooltip
)

Parameters

documentOffset

Document offset at which to insert the text.

targetUri

Link's target URI.

error

If there's an error, this out parameter is set to the error information.

displayText

Text to display in the document for this hyperlink. If null is specified then targetUri is used.

tooltip

Tool-tip to display when the user hovers mouse over the link.

Return Value

Hyperlink node that was inserted as a result of this operation. If an error occurs null is returned.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2