Class
DecorationUILayerBase

Represents a base class for decorative UI layers in the Telerik RadRichTextBox.

Definition

Constructors

DecorationUILayerBase()

Declaration

cs-api-definition
public DecorationUILayerBase()

Properties

Document

Declaration

cs-api-definition
protected RadDocument Document { get; }

Property Value

RadDocument

IsHitTestVisible

Gets or sets a value indicating whether the UI layer is hit test visible.

Declaration

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

Property Value

bool

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

Implements IUILayer.IsHitTestVisible

Name

Gets or sets the name of the decoration UI layer.

Declaration

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

Property Value

string

The name of the decoration UI layer as a string.

Implements IUILayer.Name

ShouldClip

Determines whether the decoration UI layer should be clipped to its bounds.

Declaration

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

Property Value

bool

Implements IUILayer.ShouldClip

ShouldUpdateWhenNotInvalidated

Determines whether the decoration UI 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

AddDecorationElement(UIElement)

Declaration

cs-api-definition
protected void AddDecorationElement(UIElement element)

Parameters

element

UIElement

ArrangeChildren()

Arranges the child elements within the decoration layer, positioning them appropriately based on the current layout and available space.

Declaration

cs-api-definition
public virtual void ArrangeChildren()

Implements IUILayer.ArrangeChildren()

Clear()

Declaration

cs-api-definition
protected virtual void Clear()

ClearChildren()

Clears all child elements from the decoration UI layer.

Declaration

cs-api-definition
public virtual void ClearChildren()

Implements IUILayer.ClearChildren()

DoOnPresentationChanged()

Executes any necessary actions when the presentation has changed.

Declaration

cs-api-definition
public virtual void DoOnPresentationChanged()

Implements IUILayer.DoOnPresentationChanged()

GetLayerUIElement()

Retrieves the UI element associated with the decoration layer.

Declaration

cs-api-definition
public UIElement GetLayerUIElement()

Returns

UIElement

The UI element that represents the decoration layer.

Implements IUILayer.GetLayerUIElement()

OnDocumentChanged()

Declaration

cs-api-definition
protected virtual void OnDocumentChanged()

OnDocumentChanging()

Declaration

cs-api-definition
protected virtual void OnDocumentChanging()

UpdateUIViewPortOverride(UILayerUpdateContext)

Updates the view port override for the decoration UI layer based on the given update context.

Declaration

cs-api-definition
public abstract void UpdateUIViewPortOverride(UILayerUpdateContext context)

Parameters

context

UILayerUpdateContext

The context that provides the necessary information for updating the UI layer.

UpdateViewPort(UILayerUpdateContext)

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

Declaration

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

Parameters

context

UILayerUpdateContext

The context that contains the information needed to update the UI layer.

Implements IUILayer.UpdateViewPort(UILayerUpdateContext)