Class
HyperlinkUIProviderBase

Represents a base class for hyperlink UI providers in the RadRichTextBox. This class provides functionality to manage hyperlinks within the document's UI context.

Definition

Namespace:Telerik.Windows.Documents.UI.UIProviders

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

cs-api-definition
public abstract class HyperlinkUIProviderBase : IUIProvider

Inheritance: objectHyperlinkUIProviderBase

Derived Classes: DrawingUIProviderHyperlinkUIProvider

Implements: IUIProvider

Constructors

HyperlinkUIProviderBase()

Declaration

cs-api-definition
protected HyperlinkUIProviderBase()

Properties

BoundingRectangle

Gets the bounding rectangle of the hyperlink UI element.

Declaration

cs-api-definition
public abstract RectangleF BoundingRectangle { get; }

Property Value

RectangleF

Implements IUIProvider.BoundingRectangle

ContainingLayer

Gets the layer that contains the hyperlink UI elements.

Declaration

cs-api-definition
public IUILayer ContainingLayer { get; set; }

Property Value

IUILayer

Implements IUIProvider.ContainingLayer

HyperlinkInline

Represents the hyperlink inline element within the Hyperlink UI provider.

Declaration

cs-api-definition
public abstract Inline HyperlinkInline { get; }

Property Value

Inline

IsInvalidated

Gets a value indicating whether the hyperlink UI provider has been invalidated.

Declaration

cs-api-definition
public abstract bool IsInvalidated { get; }

Property Value

bool

Implements IUIProvider.IsInvalidated

IsRemoved

Gets a value indicating whether the hyperlink has been removed.

Declaration

cs-api-definition
public abstract bool IsRemoved { get; }

Property Value

bool

Implements IUIProvider.IsRemoved

UIElement

Gets the UI element associated with the Hyperlink UI Provider.

Declaration

cs-api-definition
public abstract FrameworkElement UIElement { get; }

Property Value

FrameworkElement

Methods

Arrange(UILayerUpdateContext)

Arranges the UI elements for the hyperlink provider, updating the specified UI layer context.

Declaration

cs-api-definition
public abstract void Arrange(UILayerUpdateContext uILayerUpdateContext)

Parameters

uILayerUpdateContext

UILayerUpdateContext

The context that contains information about how the UI layer should be updated.

Implements IUIProvider.Arrange(UILayerUpdateContext)

GetUIElements(UILayerUpdateContext)

Retrieves the user interface elements associated with the hyperlink provider.

Declaration

cs-api-definition
public abstract IEnumerable<UIElement> GetUIElements(UILayerUpdateContext context)

Parameters

context

UILayerUpdateContext

The context of the UI layer update that contains information needed to generate the UI elements.

Returns

IEnumerable<UIElement>

A collection of UI elements that represent the hyperlinks in the document.

Implements IUIProvider.GetUIElements(UILayerUpdateContext)

RegisterHyperlinkHandlers(UIElement)

Declaration

cs-api-definition
protected void RegisterHyperlinkHandlers(UIElement uiElement)

Parameters

uiElement

UIElement

ReleaseElements()

Releases the elements managed by the HyperlinkUIProviderBase class.

Declaration

cs-api-definition
public abstract void ReleaseElements()

Implements IUIProvider.ReleaseElements()

UnregisterHyperlinkHandlers(UIElement)

Declaration

cs-api-definition
protected void UnregisterHyperlinkHandlers(UIElement uiElement)

Parameters

uiElement

UIElement

UpdateUI(UILayerUpdateContext)

Updates the user interface for the hyperlink provider based on the specified update context.

Declaration

cs-api-definition
public abstract void UpdateUI(UILayerUpdateContext uILayerUpdateContext)

Parameters

uILayerUpdateContext

UILayerUpdateContext

The context that contains information about the UI layer update.

Implements IUIProvider.UpdateUI(UILayerUpdateContext)