Class UILayerUpdateContext

Represents the context for updating a user interface layer in the Telerik document management system.

Inheritance
System.Object
UILayerUpdateContext
Namespace: Telerik.Windows.Documents.UI.Layers
Assembly: Telerik.Windows.Controls.RichTextBox.dll

Syntax

public class UILayerUpdateContext : Object

Constructors

UILayerUpdateContext(Nullable<PointF>, RectangleF, IUILayerContainer, SectionLayoutBox)

Declaration
public UILayerUpdateContext(Nullable<PointF> viewOffset, RectangleF viewPort, IUILayerContainer presenter, SectionLayoutBox currentSection)
Parameters
System.Nullable<PointF> viewOffset

RectangleF viewPort

IUILayerContainer presenter

SectionLayoutBox currentSection

Properties

CurrentSectionBox

Gets the current section box of the UILayer update context.

Declaration
public SectionLayoutBox CurrentSectionBox { get; }
Property Value
SectionLayoutBox

FilterFloatingBlocksWithViewPort

Filters floating blocks within the view port of the UI layer update context.

Declaration
public bool FilterFloatingBlocksWithViewPort { get; set; }
Property Value
System.Boolean

Presenter

Represents the presenter associated with the UI layer update context.

Declaration
public IUILayerContainer Presenter { get; }
Property Value
IUILayerContainer

ViewOffset

Gets or sets the current view offset of the UI layer.

Declaration
public PointF ViewOffset { get; }
Property Value
PointF

A PointF representing the view offset.

ViewPort

Represents the viewport of the UI Layer Update Context, providing information about the visible area of the UI layer.

Declaration
public RectangleF ViewPort { get; }
Property Value
RectangleF

Methods

GetVisibleFloatingBlocks()

Retrieves a collection of currently visible floating blocks in the UI layer.

Declaration
public IEnumerable<FloatingBlockLayoutBox> GetVisibleFloatingBlocks()
Returns
System.Collections.Generic.IEnumerable<FloatingBlockLayoutBox>

A collection of visible floating blocks.

GetVisibleLayoutBoxes()

Retrieves a collection of visible layout boxes within the UI layer.

Declaration
public IEnumerable<LayoutBox> GetVisibleLayoutBoxes()
Returns
System.Collections.Generic.IEnumerable<LayoutBox>

An enumerable collection of layout boxes that are currently visible in the user interface.

GetVisibleLayoutBoxes<T>()

Retrieves a collection of visible layout boxes of type T from the UILayerUpdateContext.

Declaration
public IEnumerable<T> GetVisibleLayoutBoxes<T>()
    where T : LayoutBox
Returns
System.Collections.Generic.IEnumerable<T>

A collection of visible layout boxes of the specified type T.
Type Parameters
T

GetVisibleLayoutBoxes<T>(Predicate<T>)

Retrieves a collection of visible layout boxes that match the specified predicate.

Declaration
public IEnumerable<T> GetVisibleLayoutBoxes<T>(Predicate<T> filter)
    where T : LayoutBox
Parameters
System.Predicate<T> filter

A function that evaluates each element and returns a boolean indicating whether the element should be included in the result.
Returns
System.Collections.Generic.IEnumerable<T>

A collection of layout boxes of type T that are currently visible and satisfy the given predicate.
Type Parameters
T

GetVisibleTextLayoutBoxes()

Retrieves a collection of visible text layout boxes from the UI layer update context.

Declaration
public IEnumerable<SpanLayoutBox> GetVisibleTextLayoutBoxes()
Returns
System.Collections.Generic.IEnumerable<SpanLayoutBox>

A collection of visible text layout boxes that represent the current state of the text in the UI layer.

Extension Methods