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

Provides shared hyperlink interaction handling for inline visuals hosted by document UI layers.

Definition

Namespace:Telerik.WinForms.Documents.UI.UIProviders

Assembly:Telerik.WinControls.RichTextEditor.dll

Syntax:

C#
public abstract class HyperlinkUIProviderBase : IUIProvider

Inheritance: objectHyperlinkUIProviderBase

Derived Classes: DrawingUIProviderHyperlinkUIProviderImageUIProvider

Implements: IUIProvider

Constructors

C#
protected HyperlinkUIProviderBase()

Properties

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

C#
public abstract RectangleF BoundingRectangle { get; }

Implements: IUIProvider.BoundingRectangle

Gets or sets the layer to which this provider's visual elements are attached.

C#
public IUILayer ContainingLayer { get; set; }

Implements: IUIProvider.ContainingLayer

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

C#
public abstract Inline HyperlinkInline { get; }

Gets whether the layer should discard this provider and obtain a current one on its next update.

C#
public abstract bool IsInvalidated { get; }

Implements: IUIProvider.IsInvalidated

Gets whether the associated document element has been removed.

C#
public abstract bool IsRemoved { get; }

Implements: IUIProvider.IsRemoved

Gets the framework element that receives hyperlink pointer interaction.

C#
public abstract FrameworkElement UIElement { get; }

Methods

Positions the provider's visual elements using the current layout and view offset.

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

The current layer context.

Implements: IUIProvider.Arrange(UILayerUpdateContext)

Gets the visual elements that represent the associated inline in the layer.

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

The presenter and viewport information for the update.

Returns:

IEnumerable<UIElement>

The visual elements to host in the layer.

Implements: IUIProvider.GetUIElements(UILayerUpdateContext)

Attaches pointer handlers that follow the document's hyperlink navigation mode and updates the tooltip when a format is configured.

C#
protected void RegisterHyperlinkHandlers(UIElement uiElement)
Parameters:uiElementUIElement

The visual that should respond to hyperlink interaction.

Detaches hyperlink handlers and releases the provider's visual resources.

C#
public abstract void ReleaseElements()

Implements: IUIProvider.ReleaseElements()

Detaches the hyperlink pointer handlers previously attached to a visual.

C#
protected void UnregisterHyperlinkHandlers(UIElement uiElement)
Parameters:uiElementUIElement

The visual from which to remove the handlers.

Refreshes the provider's existing visual elements for a new layer context.

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

The current layer context.

Implements: IUIProvider.UpdateUI(UILayerUpdateContext)