Class
UIElementsLayer

Represents a layer in the UI that handles various UI elements for Telerik documents.

Definition

Namespace:Telerik.Windows.Documents.UI.Layers

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

cs-api-definition
public class UIElementsLayer : IUILayer

Inheritance: objectUIElementsLayer

Derived Classes: ShapePreviewLayerTableMovementUILayer

Implements: IUILayer

Constructors

UIElementsLayer(string)

Declaration

cs-api-definition
public UIElementsLayer(string name)

Parameters

name

string

UIElementsLayer(string, bool)

Declaration

cs-api-definition
public UIElementsLayer(string name, bool shouldUpdateWhenNotInvalidated)

Parameters

name

string

shouldUpdateWhenNotInvalidated

bool

Fields

container

Declaration

cs-api-definition
public Canvas container

Field Value

Canvas

Properties

CurrentUpdateContext

Gets the current update context for the UI elements layer.

Declaration

cs-api-definition
public UILayerUpdateContext CurrentUpdateContext { get; }

Property Value

UILayerUpdateContext

IsHitTestVisible

Gets or sets a value indicating whether the layer can receive hit test queries.

Declaration

cs-api-definition
public bool IsHitTestVisible { get; set; }

Property Value

bool

True if the layer is hit test visible; otherwise, false.

Implements IUILayer.IsHitTestVisible

Name

Gets the name of the UIElementsLayer.

Declaration

cs-api-definition
public virtual string Name { get; }

Property Value

string

Implements IUILayer.Name

ShouldClip

Determines whether the UI elements within the layer should be clipped.

Declaration

cs-api-definition
public virtual bool ShouldClip { get; }

Property Value

bool

Implements IUILayer.ShouldClip

ShouldUpdateWhenNotInvalidated

Determines whether the UI elements layer should be updated when it has not been invalidated.

Declaration

cs-api-definition
public virtual bool ShouldUpdateWhenNotInvalidated { get; }

Property Value

bool

Implements IUILayer.ShouldUpdateWhenNotInvalidated

Methods

AddChild(UIElement)

Adds a child UIElement to the UIElementsLayer.

Declaration

cs-api-definition
public void AddChild(UIElement uiElement)

Parameters

uiElement

UIElement

The UIElement to be added as a child.

ArrangeChildren()

Arranges the child elements of the UI elements layer.

Declaration

cs-api-definition
public virtual void ArrangeChildren()

Implements IUILayer.ArrangeChildren()

ClearChildren()

Removes all child elements from the UIElementsLayer.

Declaration

cs-api-definition
public void ClearChildren()

Implements IUILayer.ClearChildren()

ClearLayerOverride()

Declaration

cs-api-definition
protected virtual void ClearLayerOverride()

DoOnPresentationChanged()

Executes a specified action when the presentation is changed.

Declaration

cs-api-definition
public virtual void DoOnPresentationChanged()

Implements IUILayer.DoOnPresentationChanged()

GetLayerUIElement()

Retrieves the UI element associated with the UIElementsLayer.

Declaration

cs-api-definition
public UIElement GetLayerUIElement()

Returns

UIElement

The UI element associated with the current layer, or null if no element is associated.

Implements IUILayer.GetLayerUIElement()

UpdateViewPort(UILayerUpdateContext)

Updates the viewport of the UI elements layer based on the specified update context.

Declaration

cs-api-definition
public void UpdateViewPort(UILayerUpdateContext context)

Parameters

context

UILayerUpdateContext

The context that contains information about the update, such as the new dimensions and position of the viewport.

Implements IUILayer.UpdateViewPort(UILayerUpdateContext)

UpdateViewPortOverride(UILayerUpdateContext)

Updates the viewport override for the UI elements layer based on the specified update context.

Declaration

cs-api-definition
public virtual void UpdateViewPortOverride(UILayerUpdateContext context)

Parameters

context

UILayerUpdateContext

The context containing information about the UI layer update.