Class
DrawingUIProvider

Provides UI elements for drawing operations in a Telerik application.

Definition

Namespace:Telerik.Windows.Documents.UI.UIProviders

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

cs-api-definition
public abstract class DrawingUIProvider : HyperlinkUIProviderBase, IUIProvider

Inheritance: objectHyperlinkUIProviderBaseDrawingUIProvider

Derived Classes: ImageUIProviderShapeUIProvider

Implements: IUIProvider

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

Constructors

DrawingUIProvider(DrawingLayoutBox)

Declaration

cs-api-definition
public DrawingUIProvider(DrawingLayoutBox drawingBox)

Parameters

drawingBox

DrawingLayoutBox

Properties

BoundingRectangle

Gets the bounding rectangle of the Drawing UI provider, which represents the area occupied by the UI elements.

Declaration

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

Property Value

RectangleF

Overrides HyperlinkUIProviderBase.BoundingRectangle

CurrentUpdateContext

Gets the current update context for the Drawing UI Provider. This context holds information about the current state of updates in the drawing components.

Declaration

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

Property Value

UILayerUpdateContext

DrawingBox

Declaration

cs-api-definition
protected DrawingLayoutBox DrawingBox { get; }

Property Value

DrawingLayoutBox

DrawingControl

Represents the DrawingControl used for rendering and interacting with drawing elements in the UI.

Declaration

cs-api-definition
public FrameworkElement DrawingControl { get; set; }

Property Value

FrameworkElement

HyperlinkInline

Represents a hyperlink inline element in the drawing UI provider.

Declaration

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

Property Value

Inline

Overrides HyperlinkUIProviderBase.HyperlinkInline

IsInvalidated

Gets a value indicating whether the 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 Drawing UI Provider has been removed.

Declaration

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

Property Value

bool

Overrides HyperlinkUIProviderBase.IsRemoved

Declaration

cs-api-definition
protected bool IsUIElementRegisteredAsHyperlink { get; set; }

Property Value

bool

UIElement

Represents a UI element for drawing within the Telerik Windows Documents UI framework.

Declaration

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

Property Value

FrameworkElement

Overrides HyperlinkUIProviderBase.UIElement

Methods

Arrange(UILayerUpdateContext)

Arranges the drawing elements within the specified UI layer update context.

Declaration

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

Parameters

uILayerUpdateContext

UILayerUpdateContext

The context that contains information about the UI layer update.

Overrides HyperlinkUIProviderBase.Arrange(UILayerUpdateContext)

CreateDrawingControl()

Declaration

cs-api-definition
protected abstract FrameworkElement CreateDrawingControl()

Returns

FrameworkElement

GetDrawingSize()

Declaration

cs-api-definition
protected abstract SizeF GetDrawingSize()

Returns

SizeF

GetUIElements(UILayerUpdateContext)

Retrieves a collection of UI elements associated with the specified update context.

Declaration

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

Parameters

context

UILayerUpdateContext

The context that provides information about the UI layer update.

Returns

IEnumerable<UIElement>

A collection of UI elements related to the provided update context.

Overrides HyperlinkUIProviderBase.GetUIElements(UILayerUpdateContext)

RegisterControl(FrameworkElement)

Declaration

cs-api-definition
protected void RegisterControl(FrameworkElement result)

Parameters

result

FrameworkElement

ReleaseElements()

Releases the resources used by the drawing UI provider, cleaning up any elements that are no longer needed.

Declaration

cs-api-definition
public override void ReleaseElements()

Overrides HyperlinkUIProviderBase.ReleaseElements()

UpdateRecycledUIElement()

Declaration

cs-api-definition
protected abstract void UpdateRecycledUIElement()