Class
UILayerUpdateContext

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

Definition

Namespace:Telerik.Windows.Documents.UI.Layers

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

cs-api-definition
public class UILayerUpdateContext

Inheritance: objectUILayerUpdateContext

Constructors

UILayerUpdateContext(PointF?, RectangleF, IUILayerContainer, SectionLayoutBox)

Declaration

cs-api-definition
public UILayerUpdateContext(PointF? viewOffset, RectangleF viewPort, IUILayerContainer presenter, SectionLayoutBox currentSection)

Parameters

viewOffset

PointF?

viewPort

RectangleF

presenter

IUILayerContainer

currentSection

SectionLayoutBox

Properties

CurrentSectionBox

Gets the current section box of the UILayer update context.

Declaration

cs-api-definition
public SectionLayoutBox CurrentSectionBox { get; }

Property Value

SectionLayoutBox

FilterFloatingBlocksWithViewPort

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

Declaration

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

Property Value

bool

Presenter

Represents the presenter associated with the UI layer update context.

Declaration

cs-api-definition
public IUILayerContainer Presenter { get; }

Property Value

IUILayerContainer

ViewOffset

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

Declaration

cs-api-definition
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

cs-api-definition
public RectangleF ViewPort { get; }

Property Value

RectangleF

Methods

GetVisibleFloatingBlocks()

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

Declaration

cs-api-definition
public IEnumerable<FloatingBlockLayoutBox> GetVisibleFloatingBlocks()

Returns

IEnumerable<FloatingBlockLayoutBox>

A collection of visible floating blocks.

GetVisibleLayoutBoxes()

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

Declaration

cs-api-definition
public IEnumerable<LayoutBox> GetVisibleLayoutBoxes()

Returns

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

cs-api-definition
public IEnumerable<T> GetVisibleLayoutBoxes<T>() where T : LayoutBox

Returns

IEnumerable<T>

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

GetVisibleLayoutBoxes<T>(Predicate<T>)

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

Declaration

cs-api-definition
public IEnumerable<T> GetVisibleLayoutBoxes<T>(Predicate<T> filter) where T : LayoutBox

Parameters

filter

Predicate<T>

A function that evaluates each element and returns a boolean indicating whether the element should be included in the result.

Returns

IEnumerable<T>

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

GetVisibleTextLayoutBoxes()

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

Declaration

cs-api-definition
public IEnumerable<SpanLayoutBox> GetVisibleTextLayoutBoxes()

Returns

IEnumerable<SpanLayoutBox>

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