ClassProviderUILayerBase
Represents the base class for UI layer providers in the Telerik Windows Documents framework.
Definition
Namespace:Telerik.Windows.Documents.UI.Layers
Assembly:Telerik.Windows.Controls.RichTextBox.dll
Syntax:
public abstract class ProviderUILayerBase : IUILayerInheritance: objectProviderUILayerBase
Derived Classes:
Implements:
Constructors
ProviderUILayerBase()
Declaration
public ProviderUILayerBase()Properties
CurrentUpdateContext
Gets the current update context for the Provider UI Layer.
Declaration
public UILayerUpdateContext CurrentUpdateContext { get; }Property Value
IsHitTestVisible
Gets or sets a value indicating whether hit testing is enabled for this UI layer.
Declaration
public bool IsHitTestVisible { get; set; }Property Value
True if hit testing is enabled; otherwise, false.
Implements
Name
Gets or sets the name of the UI layer.
Declaration
public abstract string Name { get; }Property Value
The name of the UI layer as a string.
Implements
ShouldClip
Determines whether the clipping of the UI layer should be applied.
Declaration
public virtual bool ShouldClip { get; }Property Value
Implements
ShouldUpdateWhenNotInvalidated
Determines whether the UI layer should be updated when it is not invalidated.
Declaration
public virtual bool ShouldUpdateWhenNotInvalidated { get; }Property Value
Implements
UIRegistry
Gets the user interface registry associated with the ProviderUILayerBase.
Declaration
public UIProviderRegistry UIRegistry { get; }Property Value
Methods
ArrangeChildren()
Arranges the child elements of the provider UI layer.
Declaration
public void ArrangeChildren()Implements
Remarks
This method ensures that all child elements are positioned correctly within the layout.
ClearChildren()
Clears all child elements from the provider UI layer.
Declaration
public virtual void ClearChildren()Implements
Remarks
This method is typically used to reset the UI layer, removing all existing child elements and preparing it for new content.
DoOnPresentationChanged()
Executes the necessary actions when the presentation is changed.
Declaration
public virtual void DoOnPresentationChanged()Implements
EnumerateVisibleProviders()
Declaration
protected abstract IEnumerable<IUIProvider> EnumerateVisibleProviders()Returns
GetLayerUIElement()
Retrieves the user interface element associated with the current layer.
Declaration
public UIElement GetLayerUIElement()Returns
UIElement
The UI element representing the layer. This element can be null if the layer has not been initialized properly.
Implements
RemoveUIProvider(IUIProvider)
Declaration
protected abstract void RemoveUIProvider(IUIProvider provider)Parameters
provider
RemoveUIProviderNoRecycle(IUIProvider)
Declaration
protected void RemoveUIProviderNoRecycle(IUIProvider provider)Parameters
provider
ShouldRemoveProvider(IUIProvider)
Declaration
protected virtual bool ShouldRemoveProvider(IUIProvider uiProvider)Parameters
uiProvider
Returns
UpdateUI()
Declaration
protected virtual void UpdateUI()UpdateViewPort(UILayerUpdateContext)
Updates the viewport of the UI layer based on the specified update context.
Declaration
public void UpdateViewPort(UILayerUpdateContext context)Parameters
context
The context containing information for updating the UI layer.
Implements