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

Provides a canvas and viewport transform for layers that rebuild document decorations from visible layout.

Definition

Constructors

Initializes the decoration canvas and assigns its automation ID from Name.

C#
public DecorationUILayerBase()

Properties

Gets the document associated with the most recent viewport update.

C#
protected RadDocument Document { get; }

Gets or sets whether the decoration canvas participates in hit testing.

C#
public virtual bool IsHitTestVisible { get; set; }

Implements: IUILayer.IsHitTestVisible

Gets the identifier used for the layer and its automation ID.

C#
public abstract string Name { get; }

Implements: IUILayer.Name

Gets whether the presenter clips this layer to the displayed section's bounds; the default is true.

C#
public virtual bool ShouldClip { get; }

Implements: IUILayer.ShouldClip

Gets whether the layer updates for viewport changes when it is not otherwise invalidated; the default is false.

C#
public virtual bool ShouldUpdateWhenNotInvalidated { get; }

Implements: IUILayer.ShouldUpdateWhenNotInvalidated

Methods

Applies layout rounding and the current view-offset transform, then adds a decoration to the layer canvas.

C#
protected void AddDecorationElement(UIElement element)
Parameters:elementUIElement

The decoration visual to add.

Arranges child visuals; the base implementation does nothing because it applies a shared viewport transform.

C#
public virtual void ArrangeChildren()

Implements: IUILayer.ArrangeChildren()

Removes all current decoration visuals from the canvas.

C#
protected virtual void Clear()

Clears the decorations and detaches the layer from its current document.

C#
public virtual void ClearChildren()

Implements: IUILayer.ClearChildren()

Notifies the layer that its presenter changed; the base implementation does nothing.

C#
public virtual void DoOnPresentationChanged()

Implements: IUILayer.DoOnPresentationChanged()

Gets the canvas that hosts this layer's decorations.

C#
public UIElement GetLayerUIElement()
Returns:

UIElement

The decoration canvas.

Implements: IUILayer.GetLayerUIElement()

Runs after the tracked document changes; Document may be null when the layer is detached.

C#
protected virtual void OnDocumentChanged()

Runs before the layer switches away from its current document.

C#
protected virtual void OnDocumentChanging()

Rebuilds this layer's decoration visuals for the supplied viewport.

C#
public abstract void UpdateUIViewPortOverride(UILayerUpdateContext context)
Parameters:contextUILayerUpdateContext

The current layer-update context.

Updates the tracked document and view-offset transform, clears old visuals, and rebuilds decorations for the viewport.

C#
public void UpdateViewPort(UILayerUpdateContext context)
Parameters:contextUILayerUpdateContext

The current layer-update context.

Implements: IUILayer.UpdateViewPort(UILayerUpdateContext)