RichHyperlink Class
Definition
A hyperlink inline element that extends RichSpan for TextDocument integration. This is the TextDocument-backed equivalent of Avalonia.Controls.Documents.RichHyperlink.
public class RichHyperlink
Constructors
| Name | Description |
|---|---|
| RichHyperlink (2 overloads) | Initializes a new instance of the Avalonia.Controls.Documents.RichHyperlink class. |
RichHyperlink overloads
RichHyperlink Constructor
Initializes a new instance of the Avalonia.Controls.Documents.RichHyperlink class.
public RichHyperlink()
RichHyperlink Constructor
Initializes a new instance of the Avalonia.Controls.Documents.RichHyperlink class.
public RichHyperlink(Avalonia.Controls.Documents.RichInline childInline)
Parameters
childInline Avalonia.Controls.Documents.RichInline
An inline element added as the first child.
Methods
| Name | Description |
|---|---|
| ApplyStyling | Applies styling to the control if the control is initialized and styling is not already applied. Inherited from StyledElement. |
| BeginInit | Inherited from StyledElement. |
| Bind (8 overloads) | Binds a Avalonia.AvaloniaProperty to an Avalonia.Data.BindingBase. Inherited from AvaloniaObject. |
| CheckAccess | Returns a value indicating whether the current thread is the UI thread. Inherited from AvaloniaObject. |
| ClearValue (4 overloads) | Clears a Avalonia.AvaloniaProperty's local value. Inherited from AvaloniaObject. |
| CoerceValue | Coerces the specified Avalonia.AvaloniaProperty. Inherited from AvaloniaObject. |
| EndInit | Inherited from StyledElement. |
| Equals | Compares two objects using reference equality. Inherited from AvaloniaObject. |
| GetBaseValue | Inherited from AvaloniaObject. |
| GetHashCode | Gets the hash code for the object. Inherited from AvaloniaObject. |
| GetValue (3 overloads) | Gets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject. |
| IsAnimating | Checks whether a Avalonia.AvaloniaProperty is animating. Inherited from AvaloniaObject. |
| IsSet | Checks whether a Avalonia.AvaloniaProperty is set on this object. Inherited from AvaloniaObject. |
| SetCurrentValue (2 overloads) | Sets the value of a dependency property without changing its value source. Inherited from AvaloniaObject. |
| SetValue (3 overloads) | Sets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject. |
| TryGetResource | Inherited from StyledElement. |
| VerifyAccess | Checks that the current thread is the UI thread and throws if not. Inherited from AvaloniaObject. |
Properties
| Name | Description |
|---|---|
| ActualThemeVariant | Gets the UI theme that is currently used by the element, which might be different than the RequestedThemeVariantProperty. Inherited from StyledElement. |
| Background | Gets or sets the brush used to fill the background of the control. Inherited from RichTextElement. |
| BaselineAlignment | Gets or sets the baseline alignment. Inherited from RichInline. |
| Classes | Gets or sets the styled element's classes. Inherited from StyledElement. |
| ContentEnd | Gets a text pointer to the end of the content in the document. Inherited from RichTextElement. |
| ContentLength | Gets the length, in characters, that is covered by this element. Inherited from RichTextElement. |
| ContentRange | Gets the range of text that represents the entire content, or null if the content is empty or unavailable. Inherited from RichTextElement. |
| ContentStart | Gets a text pointer to the start of the content in the document. Inherited from RichTextElement. |
| DataContext | Gets or sets the control's data context. Inherited from StyledElement. |
| Dispatcher | Returns the Avalonia.AvaloniaObject.Dispatcher that this Avalonia.AvaloniaObject is associated with. Inherited from AvaloniaObject. |
| FirstChildElement | Gets the first direct child element in the document tree, or if none exists. Inherited from RichTextElement. |
| FontFamily | Gets or sets the font family used to display text. Inherited from RichTextElement. |
| FontFeatures | Gets or sets the collection of font features to apply to the text. Inherited from RichTextElement. |
| FontSize | Gets or sets the size of the font used to display text. Inherited from RichTextElement. |
| FontStretch | Gets or sets the degree to which the font is stretched horizontally. Inherited from RichTextElement. |
| FontStyle | Gets or sets the font style used to display the text. Inherited from RichTextElement. |
| FontWeight | Gets or sets the weight or thickness of the font used to display text. Inherited from RichTextElement. |
| Foreground | Gets or sets the brush used to paint the foreground of the control. Inherited from RichTextElement. |
| Inlines | Gets the inlines contained in this span. Inherited from RichSpan. |
| IsAttachedToDocument | Gets a value indicating whether this element is currently attached to a Avalonia.Controls.Documents.TextModel.TextDocument. Inherited from RichTextElement. |
| IsInitialized | Gets a value that indicates whether the element has finished initialization. Inherited from StyledElement. |
| IsVisited | Gets or sets whether this hyperlink has been visited. |
| Item | Inherited from AvaloniaObject. |
| LastChildElement | Gets the last direct child element in the document tree, or if none exists. Inherited from RichTextElement. |
| LetterSpacing | Gets or sets the letter spacing. Inherited from RichTextElement. |
| Name | Gets or sets the name of the styled element. Inherited from StyledElement. |
| NavigateUri | Gets or sets the URI to navigate to when clicked. |
| NextElement | Gets the next sibling element in the document tree, or if none exists. Inherited from RichTextElement. |
| Parent | Gets the styled element's logical parent. Inherited from StyledElement. |
| PreviousElement | Gets the previous sibling element in the document tree, or if none exists. Inherited from RichTextElement. |
| Resources | Gets or sets the styled element's resource dictionary. Inherited from StyledElement. |
| StyleKey | Gets the type by which the element is styled. Inherited from StyledElement. |
| Styles | Gets the styles for the styled element. Inherited from StyledElement. |
| TemplatedParent | Gets the styled element whose lookless template this styled element is part of. Inherited from StyledElement. |
| TextDecorations | Gets or sets the text decorations (underline, strikethrough, etc.). Inherited from RichInline. |
| TextDocument | Gets the Avalonia.Controls.Documents.TextModel.TextDocument this element is attached to, or if not attached. Inherited from RichTextElement. |
| Theme | Gets or sets the theme to be applied to the element. Inherited from StyledElement. |
| ToolTip | Gets or sets the tooltip. |
| Transitions | Gets or sets the property transitions for the control. Inherited from Animatable. |
| UnderlineStyle | Gets or sets the line style of the underline. Only takes effect when Avalonia.Controls.Documents.RichInline.TextDecorations carries an underline; null means unset and draws as Avalonia.Controls.Documents.TextModel.Formatting.UnderlineStyle.Single. Inherited from RichInline. |
IsVisited Property
Gets or sets whether this hyperlink has been visited.
public bool IsVisited { get; set; }
NavigateUri Property
Gets or sets the URI to navigate to when clicked.
public Uri NavigateUri { get; set; }
ToolTip Property
Gets or sets the tooltip.
public object ToolTip { get; set; }
Fields
IsVisitedProperty Field
Defines the Avalonia.Controls.Documents.RichHyperlink.IsVisited property.
public Avalonia.StyledProperty<bool> IsVisitedProperty
NavigateUriProperty Field
Defines the Avalonia.Controls.Documents.RichHyperlink.NavigateUri property.
public Avalonia.StyledProperty<Uri> NavigateUriProperty
RequestNavigateEvent Field
Defines the Avalonia.Controls.Documents.RichHyperlink.RequestNavigate routed event.
public Avalonia.Interactivity.RoutedEvent<Avalonia.Controls.Documents.RequestNavigateEventArgs> RequestNavigateEvent
Remarks
This event bubbles through the visual tree starting from the text view that hosts the hyperlink. Parent controls such as RichTextEditor can handle this event to implement custom navigation logic.
ToolTipProperty Field
Defines the Avalonia.Controls.Documents.RichHyperlink.ToolTip property.
public Avalonia.StyledProperty<object> ToolTipProperty
Events
| Name | Description |
|---|---|
| ActualThemeVariantChanged | Raised when the theme variant is changed on the element or an ancestor of the element. Inherited from StyledElement. |
| AttachedToLogicalTree | Raised when the styled element is attached to a rooted logical tree. Inherited from StyledElement. |
| DataContextChanged | Occurs when the Avalonia.StyledElement.DataContext property changes. Inherited from StyledElement. |
| DetachedFromLogicalTree | Raised when the styled element is detached from a rooted logical tree. Inherited from StyledElement. |
| Initialized | Occurs when the styled element has finished initialization. Inherited from StyledElement. |
| PropertyChanged | Raised when a Avalonia.AvaloniaProperty value changes on this object. Inherited from AvaloniaObject. |
| RequestNavigate | Occurs when the hyperlink is clicked and navigation is requested. |
| ResourcesChanged | Occurs when a resource in this styled element or a parent styled element has changed. Inherited from StyledElement. |
RequestNavigate Event
Occurs when the hyperlink is clicked and navigation is requested.
public event EventHandler<Avalonia.Controls.Documents.RequestNavigateEventArgs> RequestNavigate
Remarks
A bubbling Avalonia.Controls.Documents.RichHyperlink.RequestNavigateEvent is also raised on the hosting text view control. Parent controls such as RichTextEditor can handle the routed event directly. This CLR event is provided for convenience when subscribing on the hyperlink element itself. Set Avalonia.Interactivity.RoutedEventArgs.Handled to true to prevent the default behavior of launching the URI using the platform's default browser.