New to Telerik UI for WinForms? Start a free 30-day trial

Renders hyperlink spans as text visuals and updates their text, size, and tooltip as the layout changes.

Definition

Namespace:Telerik.WinForms.Documents.UI.UIProviders

Assembly:Telerik.WinControls.RichTextEditor.dll

Syntax:

C#
public class HyperlinkUIProvider : HyperlinkUIProviderBase, IUIProvider

Inheritance: objectHyperlinkUIProviderBaseHyperlinkUIProvider

Implements: IUIProvider

Inherited Members HyperlinkUIProviderBase.RegisterHyperlinkHandlers(UIElement)HyperlinkUIProviderBase.UnregisterHyperlinkHandlers(UIElement)HyperlinkUIProviderBase.ContainingLayer

Constructors

Initializes a provider for the specified hyperlink span and observes its style changes.

C#
public HyperlinkUIProvider(SpanLayoutBox spanBox)
Parameters:spanBoxSpanLayoutBox

The span layout box to render.

Properties

Gets the rectangle the layer uses to determine whether this provider intersects the current viewport.

C#
public override RectangleF BoundingRectangle { get; }

Overrides: HyperlinkUIProviderBase.BoundingRectangle

Gets the context supplied when the provider's text visual was last added to a layer.

C#
public UILayerUpdateContext CurrentUpdateContext { get; }

Gets the document inline represented by the provider and used for hyperlink navigation.

C#
public override Inline HyperlinkInline { get; }

Overrides: HyperlinkUIProviderBase.HyperlinkInline

Gets the text-block visual used to display the span.

C#
public IRadTextBlock HyperlinkTextBlock { get; }

Gets whether the observed span changed or the layout box now refers to a different span.

C#
public override bool IsInvalidated { get; }

Overrides: HyperlinkUIProviderBase.IsInvalidated

Gets whether the associated document element has been removed.

C#
public override bool IsRemoved { get; }

Overrides: HyperlinkUIProviderBase.IsRemoved

Gets the layout box whose span is rendered by this provider.

C#
public SpanLayoutBox SpanBox { get; }

Gets the framework element that receives hyperlink pointer interaction.

C#
public override FrameworkElement UIElement { get; }

Overrides: HyperlinkUIProviderBase.UIElement

Methods

Positions the text block relative to the current view offset.

C#
public override void Arrange(UILayerUpdateContext uILayerUpdateContext)
Parameters:uILayerUpdateContextUILayerUpdateContext

The current layer context.

Overrides: HyperlinkUIProviderBase.Arrange(UILayerUpdateContext)

Gets the text visual for the span; tab formatting symbols produce no visual element.

C#
public override IEnumerable<UIElement> GetUIElements(UILayerUpdateContext context)
Parameters:contextUILayerUpdateContext

The presenter and viewport information for the update.

Returns:

IEnumerable<UIElement>

The span's text visual, or an empty sequence for a tab symbol.

Overrides: HyperlinkUIProviderBase.GetUIElements(UILayerUpdateContext)

Unregisters hyperlink and span-change handlers and returns the text block to the text-block pool.

C#
public override void ReleaseElements()

Overrides: HyperlinkUIProviderBase.ReleaseElements()

Refreshes the displayed text and bounds, then updates the hyperlink tooltip.

C#
public override void UpdateUI(UILayerUpdateContext uILayerUpdateContext)
Parameters:uILayerUpdateContextUILayerUpdateContext

The current layer context.

Overrides: HyperlinkUIProviderBase.UpdateUI(UILayerUpdateContext)