ProviderUILayerBase
Provides the provider lifecycle and visual container shared by document UI layers.
Definition
Namespace:Telerik.WinForms.Documents.UI.Layers
Assembly:Telerik.WinControls.RichTextEditor.dll
Syntax:
public abstract class ProviderUILayerBase : IUILayer
Inheritance: objectProviderUILayerBase
Derived Classes:
Implements:
Constructors
Initializes the layer's transparent visual container and provider collection.
public ProviderUILayerBase()
Properties
Gets the context supplied by the most recent UpdateViewPort(UILayerUpdateContext) call.
public UILayerUpdateContext CurrentUpdateContext { get; }
Gets or sets whether the layer's visual elements participate in hit testing.
public bool IsHitTestVisible { get; set; }
Implements:
Gets the layer identifier, which is also assigned as the root visual element's automation ID when non-empty.
public abstract string Name { get; }
Implements:
Gets whether the presenter clips this layer to the displayed section's bounds. The default implementation returns true.
public virtual bool ShouldClip { get; }
Implements:
Gets whether the presenter should update this layer when it has not been invalidated.
public virtual bool ShouldUpdateWhenNotInvalidated { get; }
Implements:
Gets the provider registry associated with the owner of the current update context.
public UIProviderRegistry UIRegistry { get; }
Methods
Arranges each provider using the current update context.
public void ArrangeChildren()
Implements:
Removes all providers and their visual elements from the layer.
public virtual void ClearChildren()
Implements:
Notifies the layer that the document presentation has changed. The base implementation does nothing.
public virtual void DoOnPresentationChanged()
Implements:
Enumerates providers that should be attached for the current update context.
protected abstract IEnumerable<IUIProvider> EnumerateVisibleProviders()
IEnumerable<IUIProvider>
The providers to include in this layer's update.
Gets the transparent canvas that hosts this layer's provider elements.
Removes a provider from the layer and applies the derived layer's provider-release policy.
protected abstract void RemoveUIProvider(IUIProvider provider)
The provider to remove.
Detaches a provider's visual elements and clears its layer association without releasing the provider to the registry.
protected void RemoveUIProviderNoRecycle(IUIProvider provider)
The provider to detach.
Determines whether a provider should be removed because it is removed, invalidated, or outside the viewport.
protected virtual bool ShouldRemoveProvider(IUIProvider uiProvider)
The provider being evaluated.
Returns:true when the provider should be removed from the layer.
Updates retained providers, removes providers rejected by ShouldRemoveProvider(IUIProvider), and adds providers returned by EnumerateVisibleProviders().
protected virtual void UpdateUI()
Applies a viewport context and updates providers when the viewport has finite dimensions.
public void UpdateViewPort(UILayerUpdateContext context)
The presenter and viewport information for this update.
Implements: