Class RichComposition

Namespace

RichEdit.Core

Assembly

RichEdit.Core.dll

A provisional rich root owned by one input session while committed content remains frozen.

public sealed class RichComposition : IDisposable

Inheritance

object

RichComposition

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Generation

Gets a generation incremented by every successful provisional update.

public long Generation { get; }

Property Value

long

Selection

Gets the primary selection in provisional coordinates.

public RichSelection Selection { get; }

Property Value

RichSelection

Snapshot

Gets provisional content with an invalid document revision.

public RichDocumentSnapshot Snapshot { get; }

Property Value

RichDocumentSnapshot

Methods

Cancel()

Discards provisional content and retains the original content, selection, revision, and history.

public void Cancel()

Commit(string?)

Commits the final validated root as one authored transaction and one undo unit.

public RichEditResult Commit(string? description = null)

Parameters

description string

Returns

RichEditResult

Dispose()

Cancels an uncommitted composition.

public void Dispose()

Update(Action<RichDocumentEdit>, RichSelection?)

Stages native input operations without publishing document content or creating history.

public void Update(Action<RichDocumentEdit> update, RichSelection? selection = null)

Parameters

update Action<RichDocumentEdit>

selection RichSelection

Remarks

A resulting selection can be supplied here or through the builder, but not both.