Hyperlink Constructors

Definition

Namespace:

System.Windows.Documents

Assembly:

PresentationFramework.dll

Initializes a new instance of the Hyperlink class.

Overloads

Hyperlink()	Initializes a new, default instance of the Hyperlink class.
Hyperlink(Inline)	Initializes a new instance of the Hyperlink class, taking a specified Inline object as the initial contents of the new Hyperlink.
Hyperlink(Inline, TextPointer)	Initializes a new instance of the Hyperlink class, taking a specified Inline object as the initial contents of the new Hyperlink, and a TextPointer specifying an insertion position for the new Hyperlink.
Hyperlink(TextPointer, TextPointer)	Initializes a new instance of the Hyperlink class, taking two TextPointer objects that indicate the beginning and end of a selection of content to be contained by the new Hyperlink.

Hyperlink()

Initializes a new, default instance of the Hyperlink class.

public:
 Hyperlink();

public Hyperlink ();

Public Sub New ()

Hyperlink(Inline)

Initializes a new instance of the Hyperlink class, taking a specified Inline object as the initial contents of the new Hyperlink.

public:
 Hyperlink(System::Windows::Documents::Inline ^ childInline);

public Hyperlink (System.Windows.Documents.Inline childInline);

new System.Windows.Documents.Hyperlink : System.Windows.Documents.Inline -> System.Windows.Documents.Hyperlink

Public Sub New (childInline As Inline)

Parameters

childInline

Inline

An Inline object specifying the initial contents of the new Hyperlink.

Examples

The following example demonstrates usage of this constructor.

// A child Inline element for the new Hyperlink element.
Run runx = new Run("Link text for the Hyperlink element.");

// After this line executes, the new element "hyper1"
// contains the specified Inline element, "runx".
Hyperlink hyperl = new Hyperlink(runx);

' A child Inline element for the new Hyperlink element.
Dim runx As New Run("Link text for the Hyperlink element.")

' After this line executes, the new element "hyper1"
' contains the specified Inline element, "runx".
Dim hyperl As New Hyperlink(runx)

Hyperlink(Inline, TextPointer)

Initializes a new instance of the Hyperlink class, taking a specified Inline object as the initial contents of the new Hyperlink, and a TextPointer specifying an insertion position for the new Hyperlink.

public:
 Hyperlink(System::Windows::Documents::Inline ^ childInline, System::Windows::Documents::TextPointer ^ insertionPosition);

public Hyperlink (System.Windows.Documents.Inline childInline, System.Windows.Documents.TextPointer insertionPosition);

new System.Windows.Documents.Hyperlink : System.Windows.Documents.Inline * System.Windows.Documents.TextPointer -> System.Windows.Documents.Hyperlink

Public Sub New (childInline As Inline, insertionPosition As TextPointer)

Parameters

childInline

Inline

An Inline object specifying the initial contents of the new Hyperlink. This parameter may be null, in which case no Inline is inserted.

insertionPosition

TextPointer

A TextPointer specifying an insertion position at which to insert the Hyperlink element after it is created, or null for no automatic insertion.

Examples

The following example demonstrates usage of this constructor.

// A child Inline element for the new Hyperlink element.
Run runx = new Run("Link text for the Hyperlink element.");

// An empty paragraph will serve as the container for the new Hyperlink element.
Paragraph parx = new Paragraph();

// After this line executes, the new element "hyperl"
// contains the specified Inline element, "runx".  Also, "hyperl" is
// inserted at the point indicated by the insertionPosition parameter,
// which in this case indicates the content start position in the Paragraph
// element "parx".
Hyperlink hyperl = new Hyperlink(runx, parx.ContentStart);

' A child Inline element for the new Hyperlink element.
Dim runx As New Run("Link text for the Hyperlink element.")

' An empty paragraph will serve as the container for the new Hyperlink element.
Dim parx As New Paragraph()

' After this line executes, the new element "hyperl"
' contains the specified Inline element, "runx".  Also, "hyperl" is
' inserted at the point indicated by the insertionPosition parameter, 
' which in this case indicates the content start position in the Paragraph 
' element "parx".
Dim hyperl As New Hyperlink(runx, parx.ContentStart)

Hyperlink(TextPointer, TextPointer)

Initializes a new instance of the Hyperlink class, taking two TextPointer objects that indicate the beginning and end of a selection of content to be contained by the new Hyperlink.

public:
 Hyperlink(System::Windows::Documents::TextPointer ^ start, System::Windows::Documents::TextPointer ^ end);

public Hyperlink (System.Windows.Documents.TextPointer start, System.Windows.Documents.TextPointer end);

new System.Windows.Documents.Hyperlink : System.Windows.Documents.TextPointer * System.Windows.Documents.TextPointer -> System.Windows.Documents.Hyperlink

Public Sub New (start As TextPointer, end As TextPointer)

Parameters

start

TextPointer

A TextPointer indicating the beginning of a selection of content to be contained by the new Hyperlink.

end

TextPointer

A TextPointer indicating the end of a selection of content to be contained by the new Hyperlink.

Exceptions

ArgumentNullException

start or end is null.

ArgumentException

start and end do not resolve to a range of content suitable for enclosure by a Span element; for example, if start and end indicate positions in different paragraphs.

Examples

The following example demonstrates usage of this constructor.

// Create a paragraph and three text runs to serve as example content.
Paragraph parx = new Paragraph();
Run run1 = new Run("Text run 1.");
Run run2 = new Run("Text to link.");
Run run3 = new Run("Text run 3.");

// Add the three text runs to the paragraph, separated by linebreaks.
parx.Inlines.Add(run1);
parx.Inlines.Add(new LineBreak());
parx.Inlines.Add(run2);
parx.Inlines.Add(new LineBreak());
parx.Inlines.Add(run3);

// After this line executes, the selection of content
// indicated by the "start" and "end" parameters will be
// enclosed by the new Hyperlink.  In this case, the new Hyperlink
// will enclose the entire contents of the text run "run2".
Hyperlink hyperl = new Hyperlink(run2.ContentStart, run2.ContentEnd);

' Create a paragraph and three text runs to serve as example content.  
Dim parx As New Paragraph()
Dim run1 As New Run("Text run 1.")
Dim run2 As New Run("Text to link.")
Dim run3 As New Run("Text run 3.")

' Add the three text runs to the paragraph, separated by linebreaks.
parx.Inlines.Add(run1)
parx.Inlines.Add(New LineBreak())
parx.Inlines.Add(run2)
parx.Inlines.Add(New LineBreak())
parx.Inlines.Add(run3)

' After this line executes, the selection of content
' indicated by the "start" and "end" parameters will be
' enclosed by the new Hyperlink.  In this case, the new Hyperlink
' will enclose the entire contents of the text run "run2".  
Dim hyperl As New Hyperlink(run2.ContentStart, run2.ContentEnd)

Remarks

This constructor is intended to initialize a new Hyperlink element such that it encloses a selection of preexisting content.