Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Hyperlink Class

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

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

public sealed class Hyperlink : Span
<Hyperlink ...>text</Hyperlink>

The Hyperlink type exposes the following members.

  NameDescription
Public methodSupported by Silverlight for Windows PhoneHyperlinkInitializes a new instance of the Hyperlink class.
Top

  NameDescription
Public propertyCharacterSpacingGets or sets the distance between characters of text in the control measured in 1000ths of the font size. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows PhoneCommandGets or sets a command to associate with the Hyperlink.
Public propertySupported by Silverlight for Windows PhoneCommandParameterGets or sets command parameters associated with the command specified by the Command property.
Public propertySupported by Silverlight for Windows PhoneContentEndGets a TextPointer that represents the end of the content in the element. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows PhoneContentStartGets a TextPointer that represents the start of content in the element. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows PhoneDispatcherGets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
Public propertySupported by Silverlight for Windows PhoneElementEndGets a TextPointer that represents the position just after the end of the element. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows PhoneElementStartGets a TextPointer that represents the position just before the start of the element. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows PhoneFontFamilyGets or sets the preferred top-level font family for the content of the element. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows PhoneFontSizeGets or sets the font size for the content of the element. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows PhoneFontStretchGets or sets the glyph width of the font in a family to select. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows PhoneFontStyleGets or sets the font style for the content in this element. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows PhoneFontWeightGets or sets the top-level font weight to select from the font family for the content in this element. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows PhoneForegroundGets or sets the Brush to apply to the content in this element. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows PhoneInlinesGets an InlineCollection containing the top-level inline elements that include the contents of Span. (Inherited from Span.)
Public propertySupported by Silverlight for Windows PhoneLanguageGets or sets the language of the content within an TextElement element. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows PhoneMouseOverForegroundGets or sets the brush that paints the foreground color when the mouse pointer moves over the Hyperlink.
Public propertySupported by Silverlight for Windows PhoneMouseOverTextDecorationsGets or sets the TextDecorationCollection that decorates the Hyperlink.
Public propertySupported by Silverlight for Windows PhoneNameGets or sets a unique identification for the object. Name can only be set from initial parsing of XAML. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows PhoneNavigateUriGets or sets a URI to navigate to when the Hyperlink is activated.
Public propertySupported by Silverlight for Windows PhoneTargetNameGets or sets the name of a target window or frame for the Hyperlink.
Public propertySupported by Silverlight for Windows PhoneTextDecorationsGets or sets a value that specifies the text decorations that are applied to the content in an Inline element. (Inherited from Inline.)
Top

  NameDescription
Public methodSupported by Silverlight for Windows PhoneCheckAccessDetermines whether the calling thread has access to this object. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows PhoneClearValueClears the local value of a dependency property. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows PhoneEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows PhoneFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneFindNameGets an object in the Silverlight object model by referencing the object's x:Name or Name attribute value. (Inherited from TextElement.)
Public methodSupported by Silverlight for Windows PhoneGetAnimationBaseValueReturns any base value established for a Silverlight dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows PhoneGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneGetValueReturns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
Protected methodSupported by Silverlight for Windows PhoneMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows PhoneOnCreateAutomationPeerReturns a class-specific AutomationPeer implementation for use by the Silverlight automation infrastructure. (Inherited from TextElement.)
Public methodSupported by Silverlight for Windows PhoneReadLocalValueReturns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows PhoneSetValueSets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows PhoneToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public eventSupported by Silverlight for Windows PhoneClickOccurs when the left mouse button is clicked on a Hyperlink.
Top

  NameDescription
Public fieldStatic memberSupported by Silverlight for Windows PhoneCommandParameterPropertyIdentifies the CommandParameter dependency property.
Public fieldStatic memberSupported by Silverlight for Windows PhoneCommandPropertyIdentifies the Command dependency property.
Public fieldStatic memberSupported by Silverlight for Windows PhoneMouseOverForegroundPropertyIdentifies the MouseOverForeground dependency property.
Public fieldStatic memberSupported by Silverlight for Windows PhoneMouseOverTextDecorationsPropertyIdentifies the MouseOverTextDecorations dependency property.
Public fieldStatic memberSupported by Silverlight for Windows PhoneNavigateUriPropertyIdentifies the NavigateUri dependency property.
Public fieldStatic memberSupported by Silverlight for Windows PhoneTargetNamePropertyIdentifies the TargetName dependency property.
Top

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.

NoteNote:

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

Silverlight for Windows Phone 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.

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 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);
}


Silverlight

Supported in: 5, 4

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft