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

Provides the provider lifecycle and visual container shared by document UI layers.

Definition

Constructors

Initializes the layer's transparent visual container and provider collection.

C#
public ProviderUILayerBase()

Properties

Gets the context supplied by the most recent UpdateViewPort(UILayerUpdateContext) call.

C#
public UILayerUpdateContext CurrentUpdateContext { get; }

Gets or sets whether the layer's visual elements participate in hit testing.

C#
public bool IsHitTestVisible { get; set; }

Implements: IUILayer.IsHitTestVisible

Gets the layer identifier, which is also assigned as the root visual element's automation ID when non-empty.

C#
public abstract string Name { get; }

Implements: IUILayer.Name

Gets whether the presenter clips this layer to the displayed section's bounds. The default implementation returns true.

C#
public virtual bool ShouldClip { get; }

Implements: IUILayer.ShouldClip

Gets whether the presenter should update this layer when it has not been invalidated.

C#
public virtual bool ShouldUpdateWhenNotInvalidated { get; }

Implements: IUILayer.ShouldUpdateWhenNotInvalidated

Gets the provider registry associated with the owner of the current update context.

C#
public UIProviderRegistry UIRegistry { get; }

Methods

Arranges each provider using the current update context.

C#
public void ArrangeChildren()

Implements: IUILayer.ArrangeChildren()

Removes all providers and their visual elements from the layer.

C#
public virtual void ClearChildren()

Implements: IUILayer.ClearChildren()

Notifies the layer that the document presentation has changed. The base implementation does nothing.

C#
public virtual void DoOnPresentationChanged()

Implements: IUILayer.DoOnPresentationChanged()

Enumerates providers that should be attached for the current update context.

C#
protected abstract IEnumerable<IUIProvider> EnumerateVisibleProviders()
Returns:

IEnumerable<IUIProvider>

The providers to include in this layer's update.

Gets the transparent canvas that hosts this layer's provider elements.

C#
public UIElement GetLayerUIElement()
Returns:

UIElement

Implements: IUILayer.GetLayerUIElement()

Removes a provider from the layer and applies the derived layer's provider-release policy.

C#
protected abstract void RemoveUIProvider(IUIProvider provider)
Parameters:providerIUIProvider

The provider to remove.

Detaches a provider's visual elements and clears its layer association without releasing the provider to the registry.

C#
protected void RemoveUIProviderNoRecycle(IUIProvider provider)
Parameters:providerIUIProvider

The provider to detach.

Determines whether a provider should be removed because it is removed, invalidated, or outside the viewport.

C#
protected virtual bool ShouldRemoveProvider(IUIProvider uiProvider)
Parameters:uiProviderIUIProvider

The provider being evaluated.

Returns:

bool

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().

C#
protected virtual void UpdateUI()

Applies a viewport context and updates providers when the viewport has finite dimensions.

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

The presenter and viewport information for this update.

Implements: IUILayer.UpdateViewPort(UILayerUpdateContext)