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

Displays an inline image in the document layer, including hyperlink interaction and clipping for section columns.

Definition

Namespace:Telerik.WinForms.Documents.UI.UIProviders

Assembly:Telerik.WinControls.RichTextEditor.dll

Syntax:

C#
public class ImageUIProvider : HyperlinkUIProviderBase, IUIProvider

Inheritance: objectHyperlinkUIProviderBaseImageUIProvider

Implements: IUIProvider

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

Constructors

Initializes a provider for the specified inline image layout box.

C#
public ImageUIProvider(ImageLayoutBox imageBox)
Parameters:imageBoxImageLayoutBox

The layout box whose image should be displayed.

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 image 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 layout box that supplies the inline image and its dimensions.

C#
public ImageLayoutBox ImageBox { get; }

Gets the image visual hosted by this provider.

C#
public Image ImageUI { get; }

Gets whether the image layout box is a clone and the provider should be recreated.

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 framework element that receives hyperlink pointer interaction.

C#
public override FrameworkElement UIElement { get; }

Overrides: HyperlinkUIProviderBase.UIElement

Methods

Positions the image and clips it to the rendered column width when the section uses columns.

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

The current layer context.

Overrides: HyperlinkUIProviderBase.Arrange(UILayerUpdateContext)

Gets the image inside its clipping canvas, creating the image visual on the first request.

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

The presenter and viewport information for the update.

Returns:

IEnumerable<UIElement>

The clipping canvas that hosts the image visual.

Overrides: HyperlinkUIProviderBase.GetUIElements(UILayerUpdateContext)

Removes hyperlink handlers when present and clears the layout associations for the image visual.

C#
public override void ReleaseElements()

Overrides: HyperlinkUIProviderBase.ReleaseElements()

Refreshes the image visual using the owner's current scale factor.

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

The current layer context.

Overrides: HyperlinkUIProviderBase.UpdateUI(UILayerUpdateContext)