Class RichTextLayout

Namespace

RichEdit.Maui

Assembly

RichEdit.Maui.dll

Queries visible native geometry on the editor's UI thread.

public sealed class RichTextLayout

Inheritance

object

RichTextLayout

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

Capture()

Captures visible metadata, or null when no reconciled native layout is available.

public RichTextLayoutSnapshot? Capture()

Returns

RichTextLayoutSnapshot

An immutable layout capture.

CaptureInput()

Captures native input layout, including this view's provisional marked text.

public RichTextLayoutSnapshot? CaptureInput()

Returns

RichTextLayoutSnapshot

A capture whose provisional positions address CompositionSnapshot, or null before usable layout.

CreateRelativeTo(View)

Creates a facade in an ancestor view's coordinates, for composed controls.

public RichTextLayout CreateRelativeTo(View ancestor)

Parameters

ancestor View

An ancestor of the text view in the MAUI visual tree.

Returns

RichTextLayout

A layout service that translates captures and pointer hit tests to that ancestor.

GetCaretBounds(RichTextLayoutSnapshot, int, RichTextCaretAffinity)

Gets a visible caret rectangle without moving the caret.

public Rect? GetCaretBounds(RichTextLayoutSnapshot layout, int position, RichTextCaretAffinity affinity = RichTextCaretAffinity.Downstream)

Parameters

layout RichTextLayoutSnapshot

A current capture from this service.

position int

The UTF-16 source boundary.

affinity RichTextCaretAffinity

Which side of a wrap or bidirectional boundary to use.

Returns

Rect?

A visible caret rectangle, or null.

GetCaretBounds(RichTextLayoutSnapshot, TextSelection)

Gets the active caret rectangle, including unmaterialized virtual spaces measured by the native font.

public Rect? GetCaretBounds(RichTextLayoutSnapshot layout, TextSelection selection)

Parameters

layout RichTextLayoutSnapshot

selection TextSelection

Returns

Rect?

GetRangeBounds(RichTextLayoutSnapshot, TextSpan)

Gets separate visible rectangles for a source range, including wraps and bidi fragments.

public IReadOnlyList<Rect> GetRangeBounds(RichTextLayoutSnapshot layout, TextSpan range)

Parameters

layout RichTextLayoutSnapshot

A current capture from this service.

range TextSpan

The bounded source range. Empty ranges use downstream caret geometry.

Returns

IReadOnlyList<Rect>

Visible rectangles, or an empty collection.

HitTest(RichTextLayoutSnapshot, Point)

Hit-tests a local point without changing source, selection, scrolling, or folding.

public RichTextHit? HitTest(RichTextLayoutSnapshot layout, Point point)

Parameters

layout RichTextLayoutSnapshot

A current capture from this service.

point Point

A point in the same coordinate space as the capture.

Returns

RichTextHit

A source/adornment hit, or null outside the visible editor or for a stale capture.

Events

Changed

Occurs after layout, viewport, appearance, attachment, or source changes.

public event EventHandler? Changed

Event Type

EventHandler