UIElementsLayer
Hosts arbitrary UI elements in a named layer and positions associated elements from their layout boxes.
Definition
Namespace:Telerik.WinForms.Documents.UI.Layers
Assembly:Telerik.WinControls.RichTextEditor.dll
Syntax:
public class UIElementsLayer : IUILayer
Inheritance: objectUIElementsLayer
Derived Classes:
Implements:
Constructors
Initializes a layer and controls whether it updates for every viewport change.
public UIElementsLayer(string name, bool shouldUpdateWhenNotInvalidated)
The identifier used to find the layer in a UILayerStack.
shouldUpdateWhenNotInvalidatedbooltrue to update even when the layer is not invalidated; otherwise, update only when required.
Initializes a layer with the specified lookup name and the default update behavior.
public UIElementsLayer(string name)
The identifier used to find the layer in a UILayerStack.
Fields
Properties
Gets the context supplied by the most recent viewport update.
public UILayerUpdateContext CurrentUpdateContext { get; }
Gets or sets whether the hosted elements participate in hit testing.
public bool IsHitTestVisible { get; set; }
Implements:
Gets the name used to identify this layer in a UILayerStack.
public virtual string Name { get; }
Implements:
Gets whether the layer is clipped by its container.
public virtual bool ShouldClip { get; }
Implements:
Gets whether this layer updates on every viewport change even when it is not invalidated.
public virtual bool ShouldUpdateWhenNotInvalidated { get; }
Implements:
Methods
Adds a visual to the layer's canvas.
Repositions child visuals associated with layout boxes using the current view offset.
public virtual void ArrangeChildren()
Implements:
Calls ClearLayerOverride() and removes all child visuals from the canvas.
public void ClearChildren()
Implements:
Releases or resets layer-specific state before child visuals are cleared.
protected virtual void ClearLayerOverride()
Notifies the layer that its presenter changed; the base implementation does nothing.
public virtual void DoOnPresentationChanged()
Implements:
Gets the canvas that represents this layer in the presenter.
Stores the update context and invokes UpdateViewPortOverride(UILayerUpdateContext) for finite viewport dimensions.
public void UpdateViewPort(UILayerUpdateContext context)
The current layer-update context.
Implements:
Performs layer-specific work for a finite viewport; override to update or create visuals.
public virtual void UpdateViewPortOverride(UILayerUpdateContext context)
The current layer-update context.