TextContainer.Hyperlink Method

Adds hyperlink to the current paragraph.

Namespace:  BitMiracle.Docotic.Pdf.Layout
Assembly:  BitMiracle.Docotic.Pdf.Layout (in BitMiracle.Docotic.Pdf.Layout.dll)

Syntax

C#
public TextSpan Hyperlink(
	string text,
	Uri url
)
VB
Public Function Hyperlink ( 
	text As String,
	url As Uri
) As TextSpan

Parameters

text
Type: System.String
The hyperlink text.
url
Type: System.Uri
The hyperlink URI.

Return Value

Type: TextSpan
The added text.

Exceptions

ExceptionCondition
ArgumentNullExceptiontext or url is null.

Remarks

The library automatically applies Hyperlink style to hyperlinks.

This method does not complete the current paragraph. I.e., a next text chunk will be placed in the same paragraph.

See Also