Class
HyperlinkUIProvider

Provides UI-related functionalities for managing and displaying hyperlinks within the document viewer.

Definition

Namespace:Telerik.Windows.Documents.UI.UIProviders

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

cs-api-definition
public class HyperlinkUIProvider : HyperlinkUIProviderBase, IUIProvider

Inheritance: objectHyperlinkUIProviderBaseHyperlinkUIProvider

Implements: IUIProvider

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

Constructors

HyperlinkUIProvider(SpanLayoutBox)

Declaration

cs-api-definition
public HyperlinkUIProvider(SpanLayoutBox spanBox)

Parameters

spanBox

SpanLayoutBox

Properties

BoundingRectangle

Gets the bounding rectangle for the hyperlink UI provider.

Declaration

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

Property Value

RectangleF

Overrides HyperlinkUIProviderBase.BoundingRectangle

CurrentUpdateContext

Gets the current update context for the Hyperlink UI Provider.

Declaration

cs-api-definition
public UILayerUpdateContext CurrentUpdateContext { get; }

Property Value

UILayerUpdateContext

HyperlinkInline

Represents the inline element for hyperlinks in the UI provider.

Declaration

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

Property Value

Inline

Overrides HyperlinkUIProviderBase.HyperlinkInline

HyperlinkTextBlock

Represents a text block that displays a hyperlink within the user interface.

Declaration

cs-api-definition
public IRadTextBlock HyperlinkTextBlock { get; }

Property Value

IRadTextBlock

IsInvalidated

Gets a value indicating whether the Hyperlink UI provider is invalidated.

Declaration

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

Property Value

bool

Overrides HyperlinkUIProviderBase.IsInvalidated

IsRemoved

Gets a value indicating whether the hyperlink has been removed.

Declaration

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

Property Value

bool

Overrides HyperlinkUIProviderBase.IsRemoved

SpanBox

Represents a user interface provider for hyperlink operations, specifically managing the span box component of hyperlinks.

Declaration

cs-api-definition
public SpanLayoutBox SpanBox { get; }

Property Value

SpanLayoutBox

UIElement

Represents the UI element associated with the Hyperlink user interface provider.

Declaration

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

Property Value

FrameworkElement

Overrides HyperlinkUIProviderBase.UIElement

Methods

Arrange(UILayerUpdateContext)

Arranges the UI elements for the hyperlink provider based on the specified update context.

Declaration

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

Parameters

uILayerUpdateContext

UILayerUpdateContext

Overrides HyperlinkUIProviderBase.Arrange(UILayerUpdateContext)

GetUIElements(UILayerUpdateContext)

Retrieves the UI elements associated with hyperlinks in the specified update context.

Declaration

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

Parameters

context

UILayerUpdateContext

The update context that provides information about the current UI layer state.

Returns

IEnumerable<UIElement>

A collection of UI elements representing the hyperlinks.

Overrides HyperlinkUIProviderBase.GetUIElements(UILayerUpdateContext)

ReleaseElements()

Releases the elements associated with the Hyperlink UI provider, freeing any resources used.

Declaration

cs-api-definition
public override void ReleaseElements()

Overrides HyperlinkUIProviderBase.ReleaseElements()

UpdateUI(UILayerUpdateContext)

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

Declaration

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

Parameters

uILayerUpdateContext

UILayerUpdateContext

Overrides HyperlinkUIProviderBase.UpdateUI(UILayerUpdateContext)