Class
BordersUILayer

Represents a layer used for handling and rendering borders in the UI.

Definition

Namespace:Telerik.Windows.Documents.UI.Layers

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

cs-api-definition
public class BordersUILayer : IUILayer

Inheritance: objectBordersUILayer

Implements: IUILayer

Constructors

BordersUILayer()

Declaration

cs-api-definition
public BordersUILayer()

Fields

container

Declaration

cs-api-definition
public Canvas container

Field Value

Canvas

Properties

CurrentUpdateContext

Declaration

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

Property Value

UILayerUpdateContext

IsHitTestVisible

Gets or sets a value indicating whether the layer can be hit tested.

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 or sets the name of the BordersUILayer.

Declaration

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

Property Value

string

A string representing the name of the BordersUILayer.

Implements IUILayer.Name

ProvidersEnumerable

Represents a collection of border provider objects for the BordersUILayer.

Declaration

cs-api-definition
public virtual IEnumerable<LayoutBox> ProvidersEnumerable { get; }

Property Value

IEnumerable<LayoutBox>

ShouldClip

Determines whether the borders of the UI layer should be clipped.

Declaration

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

Property Value

bool

Implements IUILayer.ShouldClip

ShouldUpdateWhenNotInvalidated

Determines whether the BordersUILayer should update when it has not been invalidated.

Declaration

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

Property Value

bool

Implements IUILayer.ShouldUpdateWhenNotInvalidated

UIRegistry

Represents the user interface registry for the Borders UI layer in the Telerik Windows documents framework.

Declaration

cs-api-definition
public UIProviderRegistry UIRegistry { get; }

Property Value

UIProviderRegistry

Methods

AddChild(TableBorderUIElement)

Adds a child TableBorderUIElement to the BordersUILayer.

Declaration

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

Parameters

uiElement

TableBorderUIElement

The TableBorderUIElement to be added.

ArrangeChildren()

Arranges the child elements within the BordersUILayer.

Declaration

cs-api-definition
public void ArrangeChildren()

Implements IUILayer.ArrangeChildren()

ClearChildren()

Removes all child elements from the BordersUILayer.

Declaration

cs-api-definition
public void ClearChildren()

Implements IUILayer.ClearChildren()

Remarks

This method clears the current visual representation of borders, which can help in refreshing the layer or preparing it for new child elements.

GetLayerUIElement()

Gets the user interface element associated with the borders layer.

Declaration

cs-api-definition
public UIElement GetLayerUIElement()

Returns

UIElement

An instance of the UI element representing the borders layer.

Implements IUILayer.GetLayerUIElement()

RemoveChild(TableBorderUIElement)

Removes a child TableBorderUIElement from the BordersUILayer.

Declaration

cs-api-definition
public void RemoveChild(TableBorderUIElement existingElement)

Parameters

existingElement

TableBorderUIElement

The TableBorderUIElement to be removed from the layer.

UpdateUI()

Declaration

cs-api-definition
protected virtual void UpdateUI()

UpdateViewPort(UILayerUpdateContext)

Updates the viewport for the borders UI layer based on the provided update context.

Declaration

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

Parameters

context

UILayerUpdateContext

The context containing information for updating the UI layer.

Implements IUILayer.UpdateViewPort(UILayerUpdateContext)