Hyperlink Class

Hyperlink Class

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

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


Namespace:  System.Windows.Documents
Assembly:  System.Windows (in System.Windows.dll)
XMLNS for XAML: Not mapped to an xmlns.

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

The Hyperlink type exposes the following members.

Public methodHyperlinkInitializes a new instance of the Hyperlink class.

Public propertyCharacterSpacingGets or sets the distance between characters of text in the control measured in 1000ths of the font size. (Inherited from TextElement.)
Public propertyCommandGets or sets a command to associate with the Hyperlink.
Public propertyCommandParameterGets or sets command parameters associated with the command specified by the Command property.
Public propertyContentEndGets a TextPointer that represents the end of the content in the element. (Inherited from TextElement.)
Public propertyContentStartGets a TextPointer that represents the start of content in the element. (Inherited from TextElement.)
Public propertyDispatcherGets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
Public propertyElementEndGets a TextPointer that represents the position just after the end of the element. (Inherited from TextElement.)
Public propertyElementStartGets a TextPointer that represents the position just before the start of the element. (Inherited from TextElement.)
Public propertyFontFamilyGets or sets the preferred top-level font family for the content of the element. (Inherited from TextElement.)
Public propertyFontSizeGets or sets the font size for the content of the element. (Inherited from TextElement.)
Public propertyFontStretchGets or sets the glyph width of the font in a family to select. (Inherited from TextElement.)
Public propertyFontStyleGets or sets the font style for the content in this element. (Inherited from TextElement.)
Public propertyFontWeightGets or sets the top-level font weight to select from the font family for the content in this element. (Inherited from TextElement.)
Public propertyForegroundGets or sets the Brush to apply to the content in this element. (Inherited from TextElement.)
Public propertyInlinesGets an InlineCollection containing the top-level inline elements that include the contents of Span. (Inherited from Span.)
Public propertyLanguageGets or sets the language of the content within an TextElement element. (Inherited from TextElement.)
Public propertyMouseOverForegroundInfrastructure. Gets or sets the brush that paints the foreground color when the pointer moves over the Hyperlink.
Public propertyMouseOverTextDecorationsInfrastructure. Gets or sets the TextDecorationCollection that decorates the Hyperlink.
Public propertyNameGets or sets a unique identification for the object. Name can only be set from initial parsing of XAML. (Inherited from TextElement.)
Public propertyNavigateUriGets or sets a URI to navigate to when the Hyperlink is activated.
Public propertyTargetNameGets or sets the name of a target window or frame for the Hyperlink.
Public propertyTextDecorationsGets or sets a value that specifies the text decorations that are applied to the content in an Inline element. (Inherited from Inline.)

Public methodCheckAccessDetermines whether the calling thread has access to this object. (Inherited from DependencyObject.)
Public methodClearValueClears the local value of a dependency property. (Inherited from DependencyObject.)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodFindNameGets an object in the Windows Phone object model by referencing the object's x:Name or Name attribute value. (Inherited from TextElement.)
Public methodGetAnimationBaseValueReturns any base value established for a Windows Phone dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetValueReturns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnCreateAutomationPeerReturns a class-specific AutomationPeer implementation for use by the Windows Phone automation infrastructure. (Inherited from TextElement.)
Public methodReadLocalValueReturns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
Public methodSetValueSets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

Public eventClickOccurs when the Hyperlink is tapped.

Public fieldStatic memberCommandParameterPropertyIdentifies the CommandParameter dependency property.
Public fieldStatic memberCommandPropertyIdentifies the Command dependency property.
Public fieldStatic memberMouseOverForegroundPropertyInfrastructure. Identifies the MouseOverForeground dependency property.
Public fieldStatic memberMouseOverTextDecorationsPropertyInfrastructure. Identifies the MouseOverTextDecorations dependency property.
Public fieldStatic memberNavigateUriPropertyIdentifies the NavigateUri dependency property.
Public fieldStatic memberTargetNamePropertyIdentifies the TargetName dependency property.

You can use the Hyperlink element to display hyperlinks. Hyperlinks provide built-in focus support. Use the NavigateUri property of the Hyperlink element to specify the URL.

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

Windows Phone OS

Supported in: 8.1, 8.0, 7.1

Windows Phone

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

© 2017 Microsoft