Artikel
11/18/2011

Hyperlink Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Provides an inline-level content element that provides facilities for hosting hyperlinks.

Inheritance Hierarchy

System.Object
  System.Windows.DependencyObject
    System.Windows.Documents.TextElement
      System.Windows.Documents.Inline
        System.Windows.Documents.Span
          System.Windows.Documents.Hyperlink

Namespace: System.Windows.Documents
Assembly: System.Windows (in System.Windows.dll)

Syntax

'Declaration
Public NotInheritable Class Hyperlink _
    Inherits Span

public sealed class Hyperlink : Span

<Hyperlink ...>text</Hyperlink>

The Hyperlink type exposes the following members.

Constructors

	Name	Description
	Hyperlink	Initializes a new instance of the Hyperlink class.

Top

Properties

	Name	Description
	CharacterSpacing	Gets or sets the distance between characters of text in the control measured in 1000ths of the font size. (Inherited from TextElement.)
	Command	Gets or sets a command to associate with the Hyperlink.
	CommandParameter	Gets or sets command parameters associated with the command specified by the Command property.
	ContentEnd	Gets a TextPointer that represents the end of the content in the element. (Inherited from TextElement.)
	ContentStart	Gets a TextPointer that represents the start of content in the element. (Inherited from TextElement.)
	Dispatcher	Gets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
	ElementEnd	Gets a TextPointer that represents the position just after the end of the element. (Inherited from TextElement.)
	ElementStart	Gets a TextPointer that represents the position just before the start of the element. (Inherited from TextElement.)
	FontFamily	Gets or sets the preferred top-level font family for the content of the element. (Inherited from TextElement.)
	FontSize	Gets or sets the font size for the content of the element. (Inherited from TextElement.)
	FontStretch	Gets or sets the glyph width of the font in a family to select. (Inherited from TextElement.)
	FontStyle	Gets or sets the font style for the content in this element. (Inherited from TextElement.)
	FontWeight	Gets or sets the top-level font weight to select from the font family for the content in this element. (Inherited from TextElement.)
	Foreground	Gets or sets the Brush to apply to the content in this element. (Inherited from TextElement.)
	Inlines	Gets an InlineCollection containing the top-level inline elements that include the contents of Span. (Inherited from Span.)
	Language	Gets or sets the language of the content within an TextElement element. (Inherited from TextElement.)
	MouseOverForeground	Gets or sets the brush that paints the foreground color when the mouse pointer moves over the Hyperlink.
	MouseOverTextDecorations	Gets or sets the TextDecorationCollection that decorates the Hyperlink.
	Name	Gets or sets a unique identification for the object. Name can only be set from initial parsing of XAML. (Inherited from TextElement.)
	NavigateUri	Gets or sets a URI to navigate to when the Hyperlink is activated.
	TargetName	Gets or sets the name of a target window or frame for the Hyperlink.
	TextDecorations	Gets or sets a value that specifies the text decorations that are applied to the content in an Inline element. (Inherited from Inline.)

Top

Methods

	Name	Description
	CheckAccess	Determines whether the calling thread has access to this object. (Inherited from DependencyObject.)
	ClearValue	Clears the local value of a dependency property. (Inherited from DependencyObject.)
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	FindName	Gets an object in the Silverlight object model by referencing the object's x:Name or Name attribute value. (Inherited from TextElement.)
	GetAnimationBaseValue	Returns any base value established for a Silverlight dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue	Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnCreateAutomationPeer	Returns a class-specific AutomationPeer implementation for use by the Silverlight automation infrastructure. (Inherited from TextElement.)
	ReadLocalValue	Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
	SetValue	Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Events

	Name	Description
	Click	Occurs when the left mouse button is clicked on a Hyperlink.

Top

Fields

	Name	Description
	CommandParameterProperty	Identifies the CommandParameter dependency property.
	CommandProperty	Identifies the Command dependency property.
	MouseOverForegroundProperty	Identifies the MouseOverForeground dependency property.
	MouseOverTextDecorationsProperty	Identifies the MouseOverTextDecorations dependency property.
	NavigateUriProperty	Identifies the NavigateUri dependency property.
	TargetNameProperty	Identifies the TargetName dependency property.

Top

Remarks

You can use the Hyperlink element to display hyperlinks in a RichTextBox. Hyperlinks provide built-in mouse-over behavior and focus support. Use the NavigateUri property of the Hyperlink element to specify the URL.

Note:
You must set the IsReadOnly property of RichTextBox to true for the Hyperlink element to be active.

Silverlight for Windows Phone

When Hyperlink is used on Windows Phone, to open the Web browser, you must specify a value for the TargetName property.

Examples

The following show shows how to create a RichTextBox with a hyperlink in XAML and code.

<!--A RichTextBox with hyperlink.-->
<RichTextBox IsReadOnly="True">
    <Paragraph>
        Displaying text with <Hyperlink NavigateUri="http://www.msdn.com" TargetName="_blank">hyperlink</Hyperlink>.
    </Paragraph>
</RichTextBox>

'A RichTextBox with hyperlink.
Private Sub HyperlinkRTB()
    'Create a new RichTextBox.
    Dim MyRTB As New RichTextBox()

    ' Create a Run of plain text and hyperlink.
    Dim myRun As New Run()
    myRun.Text = "Displaying text with "
    Dim MyLink As New Hyperlink()
    MyLink.Inlines.Add("hyperlink")
    MyLink.NavigateUri = New Uri("http://www.msdn.com")
    MyLink.TargetName = "_blank"

    ' Create a paragraph and add the Run and hyperlink to it.
    Dim myParagraph As New Paragraph()
    myParagraph.Inlines.Add(myRun)
    myParagraph.Inlines.Add(MyLink)

    ' Add the paragraph to the RichTextBox.
    MyRTB.Blocks.Add(myParagraph)

    'Add the RichTextBox to the StackPanel.
    MySP.Children.Add(MyRTB)
End Sub

//A RichTextBox with hyperlink.
private void HyperlinkRTB()
{
    //Create a new RichTextBox.
    RichTextBox MyRTB = new RichTextBox();

    // Create a Run of plain text and hyperlink.
    Run myRun = new Run();
    myRun.Text = "Displaying text with ";
    Hyperlink MyLink = new Hyperlink();
    MyLink.Inlines.Add("hyperlink");
    MyLink.NavigateUri = new Uri("http://www.msdn.com");
    MyLink.TargetName = "_blank";

    // Create a paragraph and add the Run and hyperlink to it.
    Paragraph myParagraph = new Paragraph();
    myParagraph.Inlines.Add(myRun);
    myParagraph.Inlines.Add(MyLink);

    // Add the paragraph to the RichTextBox.
    MyRTB.Blocks.Add(myParagraph);

    //Add the RichTextBox to the StackPanel.
    MySP.Children.Add(MyRTB);
}

Version Information

Silverlight

Supported in: 5, 4

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Freigeben über