RichTextEditor Class

Definition

Namespace:Avalonia.Controls

Assembly:Avalonia.Controls.RichTextEditor

Package:Avalonia.Controls.RichTextEditor

A rich text editor control that provides interactive editing capabilities for FlowDocument content.

public class RichTextEditor

Inheritance: object -> AvaloniaObject -> Animatable -> StyledElement -> Visual -> Layoutable -> Interactive -> InputElement -> Control -> TemplatedControl -> RichTextEditor

Implements: IInteractiveTextHost, ITextEditorHost, ITextViewHost

Remarks

RichTextEditor is a full-featured text editing control that combines document rendering (TextViewBase) with interactive editing capabilities (text selection, keyboard input, mouse input, etc.).

Implements Avalonia.Controls.Documents.Primitives.ITextViewHost for viewport/scrolling and Avalonia.Controls.Documents.Primitives.ITextEditorHost for editing component abstraction.

Constructors

Name	Description
RichTextEditor	Initializes a new instance of the Avalonia.Controls.RichTextEditor control.

RichTextEditor Constructor

Initializes a new instance of the Avalonia.Controls.RichTextEditor control.

public RichTextEditor()

Methods

Name	Description
ClearSelection	Clears the current selection.
ClearUndoHistory	Clears the undo and redo history.
GetComponent	No summary available.
Load	Loads a document from a stream.
LoadAsync	Loads a document from a stream asynchronously.
Redo	Redoes the most recently undone editing operation.
RegisterComponent	No summary available.
Save	Saves the document to a stream.
SaveAsync	Saves the document to a stream asynchronously on a background thread.
Select	Sets the selection to the specified range.
SelectAll	Selects all text in the document.
Undo	Undoes the most recent editing operation.
UnregisterComponent	No summary available.
ApplyTemplate	Creates the visual children of the control, if necessary Inherited from TemplatedControl.
GetIsTemplateFocusTarget	Gets the value of the IsTemplateFocusTargetProperty attached property on a control. Inherited from TemplatedControl.
SetIsTemplateFocusTarget	Sets the value of the IsTemplateFocusTargetProperty attached property on a control. Inherited from TemplatedControl.
Focus	Focuses the control. Inherited from InputElement.
GetIsHoldWithMouseEnabled	Inherited from InputElement.
GetIsHoldingEnabled	Inherited from InputElement.
SetIsHoldWithMouseEnabled	Inherited from InputElement.
SetIsHoldingEnabled	Inherited from InputElement.
AddHandler (2 overloads)	Adds a handler for the specified routed event. Inherited from Interactive.
RaiseEvent	Raises a routed event. Inherited from Interactive.
RemoveHandler (2 overloads)	Removes a handler for the specified routed event. Inherited from Interactive.
Arrange	Arranges the control and its children. Inherited from Layoutable.
InvalidateArrange	Invalidates the arrangement of the control and queues a new layout pass. Inherited from Layoutable.
InvalidateMeasure	Invalidates the measurement of the control and queues a new layout pass. Inherited from Layoutable.
Measure	Carries out a measure of the control. Inherited from Layoutable.
UpdateLayout	Executes a layout pass. Inherited from Layoutable.
GetFlowDirection	Gets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual.
InvalidateVisual	Invalidates the visual and queues a repaint. Inherited from Visual.
Render	Renders the visual to a Avalonia.Media.DrawingContext. Inherited from Visual.
SetFlowDirection	Sets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual.
ApplyStyling	Applies styling to the control if the control is initialized and styling is not already applied. Inherited from StyledElement.
BeginInit	Inherited from StyledElement.
EndInit	Inherited from StyledElement.
TryGetResource	Inherited from StyledElement.
Bind (8 overloads)	Binds a Avalonia.AvaloniaProperty to an Avalonia.Data.BindingBase. Inherited from AvaloniaObject.
CheckAccess	Returns a value indicating whether the current thread is the UI thread. Inherited from AvaloniaObject.
ClearValue (4 overloads)	Clears a Avalonia.AvaloniaProperty's local value. Inherited from AvaloniaObject.
CoerceValue	Coerces the specified Avalonia.AvaloniaProperty. Inherited from AvaloniaObject.
Equals	Compares two objects using reference equality. Inherited from AvaloniaObject.
GetBaseValue	Inherited from AvaloniaObject.
GetHashCode	Gets the hash code for the object. Inherited from AvaloniaObject.
GetValue (3 overloads)	Gets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject.
IsAnimating	Checks whether a Avalonia.AvaloniaProperty is animating. Inherited from AvaloniaObject.
IsSet	Checks whether a Avalonia.AvaloniaProperty is set on this object. Inherited from AvaloniaObject.
SetCurrentValue (2 overloads)	Sets the value of a dependency property without changing its value source. Inherited from AvaloniaObject.
SetValue (3 overloads)	Sets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject.
VerifyAccess	Checks that the current thread is the UI thread and throws if not. Inherited from AvaloniaObject.

ClearSelection Method

Clears the current selection.

public void ClearSelection()

ClearUndoHistory Method

Clears the undo and redo history.

public void ClearUndoHistory()

GetComponent Method

public T GetComponent<T>()

Type Parameters

T

Returns

T

Load Method

Loads a document from a stream.

public void Load(System.IO.Stream stream, Avalonia.Controls.Documents.Serialization.IDocumentSerializer serializer)

Parameters

stream System.IO.Stream

The stream to read from.

serializer Avalonia.Controls.Documents.Serialization.IDocumentSerializer

The serializer to use.

Remarks

This is a convenience method that delegates to Avalonia.Controls.Documents.FlowDocument.Load(System.IO.Stream,Avalonia.Controls.Documents.Serialization.IDocumentSerializer).

Exceptions

• `stream` is null.
• The stream content is invalid for the format.

LoadAsync Method

Loads a document from a stream asynchronously.

public System.Threading.Tasks.Task LoadAsync(System.IO.Stream stream, Avalonia.Controls.Documents.Serialization.IDocumentSerializer serializer, System.Threading.CancellationToken cancellationToken)

Parameters

stream System.IO.Stream

The stream to read from.

serializer Avalonia.Controls.Documents.Serialization.IDocumentSerializer

The serializer to use.

cancellationToken System.Threading.CancellationToken

Cancellation token.

Returns

System.Threading.Tasks.Task

A task that completes when the load is finished.

Remarks

This delegates to Avalonia.Controls.Documents.FlowDocument.LoadAsync(System.IO.Stream,Avalonia.Controls.Documents.Serialization.IDocumentSerializer,System.Threading.CancellationToken).

Exceptions

• `stream` is null.
• The stream content is invalid for the format.

Redo Method

Redoes the most recently undone editing operation.

public void Redo()

RegisterComponent Method

public void RegisterComponent(Avalonia.Controls.Documents.Primitives.Components.ITextViewComponent component)

Parameters

component Avalonia.Controls.Documents.Primitives.Components.ITextViewComponent

Save Method

Saves the document to a stream.

public void Save(System.IO.Stream stream, Avalonia.Controls.Documents.Serialization.IDocumentSerializer serializer)

Parameters

stream System.IO.Stream

The stream to write to.

serializer Avalonia.Controls.Documents.Serialization.IDocumentSerializer

The serializer to use.

Remarks

This is a convenience method that delegates to Avalonia.Controls.Documents.FlowDocument.Save(System.IO.Stream,Avalonia.Controls.Documents.Serialization.IDocumentSerializer).

Exceptions

• `stream` is null.

SaveAsync Method

Saves the document to a stream asynchronously on a background thread.

public System.Threading.Tasks.Task SaveAsync(System.IO.Stream stream, Avalonia.Controls.Documents.Serialization.IDocumentSerializer serializer, System.Threading.CancellationToken cancellationToken)

Parameters

stream System.IO.Stream

The stream to write to.

serializer Avalonia.Controls.Documents.Serialization.IDocumentSerializer

The serializer to use.

cancellationToken System.Threading.CancellationToken

Cancellation token.

Returns

System.Threading.Tasks.Task

A task that completes when the save is finished.

Remarks

This is a convenience method that delegates to Avalonia.Controls.Documents.FlowDocument.SaveAsync(System.IO.Stream,Avalonia.Controls.Documents.Serialization.IDocumentSerializer,System.Threading.CancellationToken).

Exceptions

• `stream` is null.

Select Method

Sets the selection to the specified range.

public void Select(Avalonia.Controls.Documents.TextModel.TextPointer start, Avalonia.Controls.Documents.TextModel.TextPointer end)

Parameters

start Avalonia.Controls.Documents.TextModel.TextPointer

The start position of the selection.

end Avalonia.Controls.Documents.TextModel.TextPointer

The end position of the selection.

SelectAll Method

Selects all text in the document.

public void SelectAll()

Undo Method

Undoes the most recent editing operation.

public void Undo()

UnregisterComponent Method

public void UnregisterComponent(Avalonia.Controls.Documents.Primitives.Components.ITextViewComponent component)

Parameters

component Avalonia.Controls.Documents.Primitives.Components.ITextViewComponent

Properties

Name	Description
AcceptsReturn	Gets or sets a value indicating whether the editor accepts return key input.
AcceptsTab	Gets or sets a value indicating whether the editor accepts tab key input.
AdornerLayer	Gets the adorner layer that renders highlights, block adorners, and interactive adorner controls.
CanRedo	Gets a value indicating whether there are operations that can be redone.
CanUndo	Gets a value indicating whether there are operations that can be undone.
CaretBrush	Gets or sets the brush used to paint the caret.
Document	Gets or sets the FlowDocument to display and edit.
HighlightLayers	Gets the collection of highlight layers.
IsReadOnly	Gets or sets a value indicating whether the editor is read-only.
PageBoundsBrush	Gets or sets the brush used to render the background of the page bounds area.
Selection	Gets the text selection.
SelectionBrush	Gets or sets the brush used for selection highlighting.
SelectionFlyout	Gets or sets the selection mini-bar flyout shown when text is selected.
ShowBlockAdorners	Gets or sets whether block adorner decorations are visible.
ShowPageBounds	Gets or sets whether page boundary indicators are rendered on the underlying Avalonia.Controls.Documents.Primitives.InteractiveTextView.
ShowSelectionFlyout	Gets or sets whether the selection mini-bar flyout is shown when text is selected.
ShowToolbar	Gets or sets whether the toolbar is visible.
Toolbar	Gets or sets the custom toolbar for this editor.
UndoLimit	Gets or sets the maximum number of undo operations to retain.
UndoManager	Gets the undo manager for this editor.
Background	Gets or sets the brush used to draw the control's background. Inherited from TemplatedControl.
BackgroundSizing	Gets or sets how the control's background is drawn relative to the control's border. Inherited from TemplatedControl.
BorderBrush	Gets or sets the brush used to draw the control's border. Inherited from TemplatedControl.
BorderThickness	Gets or sets the thickness of the control's border. Inherited from TemplatedControl.
CornerRadius	Gets or sets the radius of the border rounded corners. Inherited from TemplatedControl.
FontFamily	Gets or sets the font family used to draw the control's text. Inherited from TemplatedControl.
FontFeatures	Gets or sets the font features turned on/off. Inherited from TemplatedControl.
FontSize	Gets or sets the size of the control's text in points. Inherited from TemplatedControl.
FontStretch	Gets or sets the font stretch used to draw the control's text. Inherited from TemplatedControl.
FontStyle	Gets or sets the font style used to draw the control's text. Inherited from TemplatedControl.
FontWeight	Gets or sets the font weight used to draw the control's text. Inherited from TemplatedControl.
Foreground	Gets or sets the brush used to draw the control's text and other foreground elements. Inherited from TemplatedControl.
LetterSpacing	Gets or sets the letter spacing for the control's text content. Inherited from TemplatedControl.
Padding	Gets or sets the padding placed between the border of the control and its content. Inherited from TemplatedControl.
Template	Gets or sets the template that defines the control's appearance. Inherited from TemplatedControl.
ContextFlyout	Gets or sets a context flyout to the control Inherited from Control.
ContextMenu	Gets or sets a context menu to the control. Inherited from Control.
DataTemplates	Gets or sets the data templates for the control. Inherited from Control.
FocusAdorner	Gets or sets the control's focus adorner. Inherited from Control.
IsLoaded	Gets a value indicating whether the control is fully constructed in the visual tree and both layout and render are complete. Inherited from Control.
Tag	Gets or sets a user-defined object attached to the control. Inherited from Control.
Cursor	Gets or sets associated mouse cursor. Inherited from InputElement.
Focusable	Gets or sets a value indicating whether the control can receive focus. Inherited from InputElement.
GestureRecognizers	Inherited from InputElement.
IsEffectivelyEnabled	Gets a value indicating whether this control and all its parents are enabled. Inherited from InputElement.
IsEnabled	Gets or sets a value indicating whether the control is enabled for user interaction. Inherited from InputElement.
IsFocused	Gets a value indicating whether the control is focused. Inherited from InputElement.
IsHitTestVisible	Gets or sets a value indicating whether the control is considered for hit testing. Inherited from InputElement.
IsKeyboardFocusWithin	Gets a value indicating whether keyboard focus is anywhere within the element or its visual tree child elements. Inherited from InputElement.
IsPointerOver	Gets a value indicating whether the pointer is currently over the control. Inherited from InputElement.
IsTabStop	Gets or sets a value that indicates whether the control is included in tab navigation. Inherited from InputElement.
KeyBindings	Inherited from InputElement.
TabIndex	Gets or sets a value that determines the order in which elements receive focus when the user navigates through controls by pressing the Tab key. Inherited from InputElement.
DesiredSize	Gets the size that this element computed during the measure pass of the layout process. Inherited from Layoutable.
Height	Gets or sets the height of the element. Inherited from Layoutable.
HorizontalAlignment	Gets or sets the element's preferred horizontal alignment in its parent. Inherited from Layoutable.
IsArrangeValid	Gets a value indicating whether the control's layouts arrange is valid. Inherited from Layoutable.
IsMeasureValid	Gets a value indicating whether the control's layout measure is valid. Inherited from Layoutable.
Margin	Gets or sets the margin around the element. Inherited from Layoutable.
MaxHeight	Gets or sets the maximum height of the element. Inherited from Layoutable.
MaxWidth	Gets or sets the maximum width of the element. Inherited from Layoutable.
MinHeight	Gets or sets the minimum height of the element. Inherited from Layoutable.
MinWidth	Gets or sets the minimum width of the element. Inherited from Layoutable.
UseLayoutRounding	Gets or sets a value that determines whether the element should be snapped to pixel boundaries at layout time. Inherited from Layoutable.
VerticalAlignment	Gets or sets the element's preferred vertical alignment in its parent. Inherited from Layoutable.
Width	Gets or sets the width of the element. Inherited from Layoutable.
Bounds	Gets the bounds of the control relative to its parent. Inherited from Visual.
CacheMode	Gets or sets the cache mode of the visual. Inherited from Visual.
Clip	Gets or sets the geometry clip for this visual. Inherited from Visual.
ClipToBounds	Gets or sets a value indicating whether the control should be clipped to its bounds. Inherited from Visual.
Effect	Gets or sets the effect of the control. Inherited from Visual.
FlowDirection	Gets or sets the text flow direction. Inherited from Visual.
HasMirrorTransform	Gets or sets a value indicating whether to apply mirror transform on this control. Inherited from Visual.
IsEffectivelyVisible	Gets a value indicating whether this control and all its parents are visible. Inherited from Visual.
IsVisible	Gets or sets a value indicating whether this control is visible. Inherited from Visual.
Opacity	Gets or sets the opacity of the control. Inherited from Visual.
OpacityMask	Gets or sets the opacity mask of the control. Inherited from Visual.
RenderTransform	Gets or sets the render transform of the control. Inherited from Visual.
RenderTransformOrigin	Gets or sets the transform origin of the control. Inherited from Visual.
ZIndex	Gets or sets the Z index of the control. Inherited from Visual.
ActualThemeVariant	Gets the UI theme that is currently used by the element, which might be different than the RequestedThemeVariantProperty. Inherited from StyledElement.
Classes	Gets or sets the styled element's classes. Inherited from StyledElement.
DataContext	Gets or sets the control's data context. Inherited from StyledElement.
IsInitialized	Gets a value that indicates whether the element has finished initialization. Inherited from StyledElement.
Name	Gets or sets the name of the styled element. Inherited from StyledElement.
Parent	Gets the styled element's logical parent. Inherited from StyledElement.
Resources	Gets or sets the styled element's resource dictionary. Inherited from StyledElement.
StyleKey	Gets the type by which the element is styled. Inherited from StyledElement.
Styles	Gets the styles for the styled element. Inherited from StyledElement.
TemplatedParent	Gets the styled element whose lookless template this styled element is part of. Inherited from StyledElement.
Theme	Gets or sets the theme to be applied to the element. Inherited from StyledElement.
Transitions	Gets or sets the property transitions for the control. Inherited from Animatable.
Dispatcher	Returns the Avalonia.AvaloniaObject.Dispatcher that this Avalonia.AvaloniaObject is associated with. Inherited from AvaloniaObject.
Item	Inherited from AvaloniaObject.

AcceptsReturn Property

Gets or sets a value indicating whether the editor accepts return key input.

public bool AcceptsReturn { get; set; }

AcceptsTab Property

Gets or sets a value indicating whether the editor accepts tab key input.

public bool AcceptsTab { get; set; }

AdornerLayer Property

Gets the adorner layer that renders highlights, block adorners, and interactive adorner controls.

public Avalonia.Controls.Documents.Primitives.Adorners.BlockAdornerLayer AdornerLayer { get; set; }

CanRedo Property

Gets a value indicating whether there are operations that can be redone.

public bool CanRedo { get; set; }

CanUndo Property

Gets a value indicating whether there are operations that can be undone.

public bool CanUndo { get; set; }

CaretBrush Property

Gets or sets the brush used to paint the caret.

public Avalonia.Media.IBrush CaretBrush { get; set; }

Document Property

Gets or sets the FlowDocument to display and edit.

public Avalonia.Controls.Documents.FlowDocument Document { get; set; }

HighlightLayers Property

Gets the collection of highlight layers.

public Avalonia.Controls.Documents.Primitives.Highlighting.HighlightLayerCollection HighlightLayers { get; set; }

Remarks

This collection is created eagerly and is always non-null, so layers can be added at any time — including before the visual template is applied. Layers are rendered by the Avalonia.Controls.Documents.Primitives.Adorners.BlockAdornerLayer once it becomes available.

IsReadOnly Property

Gets or sets a value indicating whether the editor is read-only.

public bool IsReadOnly { get; set; }

PageBoundsBrush Property

Gets or sets the brush used to render the background of the page bounds area.

public Avalonia.Media.IBrush PageBoundsBrush { get; set; }

Remarks

Set this property to customize the appearance of the page bounds, such as changing the background color or applying a pattern. If set to null, the default brush will be used.

Selection Property

Gets the text selection.

public Avalonia.Controls.TextSelection Selection { get; set; }

SelectionBrush Property

Gets or sets the brush used for selection highlighting.

public Avalonia.Media.IBrush SelectionBrush { get; set; }

SelectionFlyout Property

Gets or sets the selection mini-bar flyout shown when text is selected.

public Avalonia.Controls.Documents.Primitives.EditorSelectionFlyout SelectionFlyout { get; set; }

Remarks

Set this property to customize the selection mini-bar layout and actions. If null, no selection flyout is shown.

Use Avalonia.Controls.RichTextEditor.ShowSelectionFlyout to hide the flyout without replacing it.

ShowBlockAdorners Property

Gets or sets whether block adorner decorations are visible.

public bool ShowBlockAdorners { get; set; }

Remarks

Default is true. When true, registered Avalonia.Controls.Documents.Primitives.Adorners.BlockAdorner instances (e.g., dashed table borders) render over matching blocks.

ShowPageBounds Property

Gets or sets whether page boundary indicators are rendered on the underlying Avalonia.Controls.Documents.Primitives.InteractiveTextView.

public bool ShowPageBounds { get; set; }

ShowSelectionFlyout Property

Gets or sets whether the selection mini-bar flyout is shown when text is selected.

public bool ShowSelectionFlyout { get; set; }

Remarks

Default is true. Set to false to hide the selection flyout.

ShowToolbar Property

Gets or sets whether the toolbar is visible.

public bool ShowToolbar { get; set; }

Remarks

Default is true. Set to false to hide the toolbar.

Toolbar Property

Gets or sets the custom toolbar for this editor.

public Avalonia.Controls.Documents.Primitives.Toolbar.EditorToolbar Toolbar { get; set; }

Remarks

Set this property to customize the toolbar layout and actions. If null, the default toolbar is used.

Use Avalonia.Controls.RichTextEditor.ShowToolbar to hide the toolbar entirely.

UndoLimit Property

Gets or sets the maximum number of undo operations to retain.

public int UndoLimit { get; set; }

Remarks

Default value is 100. Setting this property will update the current Avalonia.Controls.RichTextEditor.UndoManager if one exists.

UndoManager Property

Gets the undo manager for this editor.

public Avalonia.Controls.Documents.Undo.IUndoManager UndoManager { get; set; }

Remarks

The Avalonia.Controls.Documents.Undo.IUndoManager is automatically created when a document is attached. Use this property for advanced scenarios such as grouping operations with Avalonia.Controls.Documents.Undo.IUndoManager.BeginUndoUnit(string,Nullable{Avalonia.Controls.Documents.Undo.SelectionSnapshot}).

Fields

Name	Description
AcceptsReturnProperty	Defines the Avalonia.Controls.RichTextEditor.AcceptsReturn property.
AcceptsTabProperty	Defines the Avalonia.Controls.RichTextEditor.AcceptsTab property.
CaretBrushProperty	Defines the Avalonia.Controls.RichTextEditor.CaretBrush property.
DocumentProperty	Defines the Avalonia.Controls.RichTextEditor.Document property.
IsReadOnlyProperty	Defines the Avalonia.Controls.RichTextEditor.IsReadOnly property.
PageBoundsBrushProperty	Defines the Avalonia.Controls.RichTextEditor.PageBoundsBrush property.
SelectionBrushProperty	Defines the Avalonia.Controls.RichTextEditor.SelectionBrush property.
SelectionFlyoutProperty	Defines the Avalonia.Controls.RichTextEditor.SelectionFlyout property.
ShowBlockAdornersProperty	Defines the Avalonia.Controls.RichTextEditor.ShowBlockAdorners property.
ShowPageBoundsProperty	Defines the Avalonia.Controls.RichTextEditor.ShowPageBounds property.
ShowSelectionFlyoutProperty	Defines the Avalonia.Controls.RichTextEditor.ShowSelectionFlyout property.
ShowToolbarProperty	Defines the Avalonia.Controls.RichTextEditor.ShowToolbar property.
ToolbarProperty	Defines the Avalonia.Controls.RichTextEditor.Toolbar property.
UndoLimitProperty	Defines the Avalonia.Controls.RichTextEditor.UndoLimit property.
BackgroundProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.Background property. Inherited from TemplatedControl.
BackgroundSizingProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.BackgroundSizing property. Inherited from TemplatedControl.
BorderBrushProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.BorderBrush property. Inherited from TemplatedControl.
BorderThicknessProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.BorderThickness property. Inherited from TemplatedControl.
CornerRadiusProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.CornerRadius property. Inherited from TemplatedControl.
FontFamilyProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.FontFamily property. Inherited from TemplatedControl.
FontFeaturesProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.FontFeaturesProperty property. Inherited from TemplatedControl.
FontSizeProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.FontSize property. Inherited from TemplatedControl.
FontStretchProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.FontWeight property. Inherited from TemplatedControl.
FontStyleProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.FontStyle property. Inherited from TemplatedControl.
FontWeightProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.FontWeight property. Inherited from TemplatedControl.
ForegroundProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.Foreground property. Inherited from TemplatedControl.
IsTemplateFocusTargetProperty	Defines the IsTemplateFocusTarget attached property. Inherited from TemplatedControl.
LetterSpacingProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.LetterSpacing property. Inherited from TemplatedControl.
PaddingProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.Padding property. Inherited from TemplatedControl.
TemplateAppliedEvent	Defines the Avalonia.Controls.Primitives.TemplatedControl.TemplateApplied routed event. Inherited from TemplatedControl.
TemplateProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.Template property. Inherited from TemplatedControl.
ContextFlyoutProperty	Defines the Avalonia.Controls.Control.ContextFlyout property Inherited from Control.
ContextMenuProperty	Defines the Avalonia.Controls.Control.ContextMenu property. Inherited from Control.
FocusAdornerProperty	Defines the Avalonia.Controls.Control.FocusAdorner property. Inherited from Control.
LoadedEvent	Defines the Avalonia.Controls.Control.Loaded event. Inherited from Control.
RequestBringIntoViewEvent	Event raised when an element wishes to be scrolled into view. Inherited from Control.
SizeChangedEvent	Defines the Avalonia.Controls.Control.SizeChanged event. Inherited from Control.
TagProperty	Defines the Avalonia.Controls.Control.Tag property. Inherited from Control.
UnloadedEvent	Defines the Avalonia.Controls.Control.Unloaded event. Inherited from Control.
ContextCanceledEvent	Provides event data for the Avalonia.Input.InputElement.ContextCanceled event. Inherited from InputElement.
ContextRequestedEvent	Provides event data for the Avalonia.Input.InputElement.ContextRequested event. Inherited from InputElement.
CursorProperty	Gets or sets associated mouse cursor. Inherited from InputElement.
DoubleTappedEvent	Defines the Avalonia.Input.InputElement.DoubleTapped event. Inherited from InputElement.
FocusableProperty	Defines the Avalonia.Input.InputElement.Focusable property. Inherited from InputElement.
GettingFocusEvent	Defines the Avalonia.Input.InputElement.GettingFocus event. Inherited from InputElement.
GotFocusEvent	Defines the Avalonia.Input.InputElement.GotFocus event. Inherited from InputElement.
HoldingEvent	Defines the Avalonia.Input.InputElement.Holding event. Inherited from InputElement.
IsEffectivelyEnabledProperty	Defines the Avalonia.Input.InputElement.IsEffectivelyEnabled property. Inherited from InputElement.
IsEnabledProperty	Defines the Avalonia.Input.InputElement.IsEnabled property. Inherited from InputElement.
IsFocusedProperty	Defines the Avalonia.Input.InputElement.IsFocused property. Inherited from InputElement.
IsHitTestVisibleProperty	Defines the Avalonia.Input.InputElement.IsHitTestVisible property. Inherited from InputElement.
IsHoldWithMouseEnabledProperty	Defines the IsHoldWithMouseEnabled attached property. Inherited from InputElement.
IsHoldingEnabledProperty	Defines the IsHoldingEnabled attached property. Inherited from InputElement.
IsKeyboardFocusWithinProperty	Defines the Avalonia.Input.InputElement.IsKeyboardFocusWithin property. Inherited from InputElement.
IsPointerOverProperty	Defines the Avalonia.Input.InputElement.IsPointerOver property. Inherited from InputElement.
IsTabStopProperty	Defines the Avalonia.Input.InputElement.IsTabStop property. Inherited from InputElement.
KeyDownEvent	Defines the Avalonia.Input.InputElement.KeyDown event. Inherited from InputElement.
KeyUpEvent	Defines the Avalonia.Input.InputElement.KeyUp event. Inherited from InputElement.
LosingFocusEvent	Defines the Avalonia.Input.InputElement.LosingFocus event. Inherited from InputElement.
LostFocusEvent	Defines the Avalonia.Input.InputElement.LostFocus event. Inherited from InputElement.
PinchEndedEvent	Defines the Avalonia.Input.InputElement.PinchEnded event. Inherited from InputElement.
PinchEvent	Defines the Avalonia.Input.InputElement.Pinch event. Inherited from InputElement.
PointerCaptureLostEvent	Defines the Avalonia.Input.InputElement.PointerCaptureLost routed event. Inherited from InputElement.
PointerEnteredEvent	Defines the Avalonia.Input.InputElement.PointerEntered event. Inherited from InputElement.
PointerExitedEvent	Defines the Avalonia.Input.InputElement.PointerExited event. Inherited from InputElement.
PointerMovedEvent	Defines the Avalonia.Input.InputElement.PointerMoved event. Inherited from InputElement.
PointerPressedEvent	Defines the Avalonia.Input.InputElement.PointerPressed event. Inherited from InputElement.
PointerReleasedEvent	Defines the Avalonia.Input.InputElement.PointerReleased event. Inherited from InputElement.
PointerTouchPadGestureMagnifyEvent	Defines the Avalonia.Input.InputElement.PointerTouchPadGestureMagnify event. Inherited from InputElement.
PointerTouchPadGestureRotateEvent	Defines the Avalonia.Input.InputElement.PointerTouchPadGestureRotate event. Inherited from InputElement.
PointerTouchPadGestureSwipeEvent	Defines the Avalonia.Input.InputElement.PointerTouchPadGestureSwipe event. Inherited from InputElement.
PointerWheelChangedEvent	Defines the Avalonia.Input.InputElement.PointerWheelChanged event. Inherited from InputElement.
PullGestureEndedEvent	Defines the Avalonia.Input.InputElement.PullGestureEnded event. Inherited from InputElement.
PullGestureEvent	Defines the Avalonia.Input.InputElement.PullGesture event. Inherited from InputElement.
RightTappedEvent	Defines the Avalonia.Input.InputElement.RightTapped event. Inherited from InputElement.
ScrollGestureEndedEvent	Defines the Avalonia.Input.InputElement.ScrollGestureEnded event. Inherited from InputElement.
ScrollGestureEvent	Defines the Avalonia.Input.InputElement.ScrollGesture event. Inherited from InputElement.
ScrollGestureInertiaStartingEvent	Defines the Avalonia.Input.InputElement.ScrollGestureInertiaStarting event. Inherited from InputElement.
SwipeGestureEndedEvent	Defines the Avalonia.Input.InputElement.SwipeGestureEnded event. Inherited from InputElement.
SwipeGestureEvent	Defines the Avalonia.Input.InputElement.SwipeGesture event. Inherited from InputElement.
TabIndexProperty	Defines the Avalonia.Input.InputElement.TabIndex property. Inherited from InputElement.
TappedEvent	Defines the Avalonia.Input.InputElement.Tapped event. Inherited from InputElement.
TextInputEvent	Defines the Avalonia.Input.InputElement.TextInput event. Inherited from InputElement.
TextInputMethodClientRequestedEvent	Defines the Avalonia.Input.InputElement.TextInputMethodClientRequested event. Inherited from InputElement.
DesiredSizeProperty	Defines the Avalonia.Layout.Layoutable.DesiredSize property. Inherited from Layoutable.
HeightProperty	Defines the Avalonia.Layout.Layoutable.Height property. Inherited from Layoutable.
HorizontalAlignmentProperty	Defines the Avalonia.Layout.Layoutable.HorizontalAlignment property. Inherited from Layoutable.
MarginProperty	Defines the Avalonia.Layout.Layoutable.Margin property. Inherited from Layoutable.
MaxHeightProperty	Defines the Avalonia.Layout.Layoutable.MaxHeight property. Inherited from Layoutable.
MaxWidthProperty	Defines the Avalonia.Layout.Layoutable.MaxWidth property. Inherited from Layoutable.
MinHeightProperty	Defines the Avalonia.Layout.Layoutable.MinHeight property. Inherited from Layoutable.
MinWidthProperty	Defines the Avalonia.Layout.Layoutable.MinWidth property. Inherited from Layoutable.
UseLayoutRoundingProperty	Defines the Avalonia.Layout.Layoutable.UseLayoutRounding property. Inherited from Layoutable.
VerticalAlignmentProperty	Defines the Avalonia.Layout.Layoutable.VerticalAlignment property. Inherited from Layoutable.
WidthProperty	Defines the Avalonia.Layout.Layoutable.Width property. Inherited from Layoutable.
BoundsProperty	Defines the Avalonia.Visual.Bounds property. Inherited from Visual.
CacheModeProperty	Defines the Avalonia.Visual.CacheMode property. Inherited from Visual.
ClipProperty	Defines the Avalonia.Visual.Clip property. Inherited from Visual.
ClipToBoundsProperty	Defines the Avalonia.Visual.ClipToBounds property. Inherited from Visual.
EffectProperty	Defines the Avalonia.Visual.Effect property. Inherited from Visual.
FlowDirectionProperty	Defines the Avalonia.Visual.FlowDirection property. Inherited from Visual.
HasMirrorTransformProperty	Defines the Avalonia.Visual.HasMirrorTransform property. Inherited from Visual.
IsVisibleProperty	Defines the Avalonia.Visual.IsVisible property. Inherited from Visual.
OpacityMaskProperty	Defines the Avalonia.Visual.OpacityMask property. Inherited from Visual.
OpacityProperty	Defines the Avalonia.Visual.Opacity property. Inherited from Visual.
RenderTransformOriginProperty	Defines the Avalonia.Visual.RenderTransformOrigin property. Inherited from Visual.
RenderTransformProperty	Defines the Avalonia.Visual.RenderTransform property. Inherited from Visual.
VisualParentProperty	Defines the Avalonia.Visual.VisualParent property. Inherited from Visual.
ZIndexProperty	Defines the Avalonia.Visual.ZIndex property. Inherited from Visual.
DataContextProperty	Defines the Avalonia.StyledElement.DataContext property. Inherited from StyledElement.
NameProperty	Defines the Avalonia.StyledElement.Name property. Inherited from StyledElement.
ParentProperty	Defines the Avalonia.StyledElement.Parent property. Inherited from StyledElement.
TemplatedParentProperty	Defines the Avalonia.StyledElement.TemplatedParent property. Inherited from StyledElement.
ThemeProperty	Defines the Avalonia.StyledElement.Theme property. Inherited from StyledElement.
TransitionsProperty	Defines the Avalonia.Animation.Animatable.Transitions property. Inherited from Animatable.

AcceptsReturnProperty Field

Defines the Avalonia.Controls.RichTextEditor.AcceptsReturn property.

public Avalonia.StyledProperty<bool> AcceptsReturnProperty

AcceptsTabProperty Field

Defines the Avalonia.Controls.RichTextEditor.AcceptsTab property.

public Avalonia.StyledProperty<bool> AcceptsTabProperty

CaretBrushProperty Field

Defines the Avalonia.Controls.RichTextEditor.CaretBrush property.

public Avalonia.StyledProperty<Avalonia.Media.IBrush> CaretBrushProperty

DocumentProperty Field

Defines the Avalonia.Controls.RichTextEditor.Document property.

public Avalonia.StyledProperty<Avalonia.Controls.Documents.FlowDocument> DocumentProperty

IsReadOnlyProperty Field

Defines the Avalonia.Controls.RichTextEditor.IsReadOnly property.

public Avalonia.StyledProperty<bool> IsReadOnlyProperty

PageBoundsBrushProperty Field

Defines the Avalonia.Controls.RichTextEditor.PageBoundsBrush property.

public Avalonia.StyledProperty<Avalonia.Media.IBrush> PageBoundsBrushProperty

SelectionBrushProperty Field

Defines the Avalonia.Controls.RichTextEditor.SelectionBrush property.

public Avalonia.StyledProperty<Avalonia.Media.IBrush> SelectionBrushProperty

SelectionFlyoutProperty Field

Defines the Avalonia.Controls.RichTextEditor.SelectionFlyout property.

public Avalonia.StyledProperty<Avalonia.Controls.Documents.Primitives.EditorSelectionFlyout> SelectionFlyoutProperty

ShowBlockAdornersProperty Field

Defines the Avalonia.Controls.RichTextEditor.ShowBlockAdorners property.

public Avalonia.StyledProperty<bool> ShowBlockAdornersProperty

ShowPageBoundsProperty Field

Defines the Avalonia.Controls.RichTextEditor.ShowPageBounds property.

public Avalonia.StyledProperty<bool> ShowPageBoundsProperty

ShowSelectionFlyoutProperty Field

Defines the Avalonia.Controls.RichTextEditor.ShowSelectionFlyout property.

public Avalonia.StyledProperty<bool> ShowSelectionFlyoutProperty

ShowToolbarProperty Field

Defines the Avalonia.Controls.RichTextEditor.ShowToolbar property.

public Avalonia.StyledProperty<bool> ShowToolbarProperty

ToolbarProperty Field

Defines the Avalonia.Controls.RichTextEditor.Toolbar property.

public Avalonia.StyledProperty<Avalonia.Controls.Documents.Primitives.Toolbar.EditorToolbar> ToolbarProperty

UndoLimitProperty Field

Defines the Avalonia.Controls.RichTextEditor.UndoLimit property.

public Avalonia.StyledProperty<int> UndoLimitProperty

Events

Name	Description
ContentChanged	Occurs when the document content changes.
DocumentChanged	Occurs when the document is replaced.
IsReadOnlyChanged	Occurs when the Avalonia.Controls.RichTextEditor.IsReadOnly property changes.
SelectionChanged	Occurs when the selection changes.
TemplateApplied	Raised when the control's template is applied. Inherited from TemplatedControl.
Loaded	Occurs when the control has been fully constructed in the visual tree and both layout and render are complete. Inherited from Control.
SizeChanged	Occurs when the bounds (actual size) of the control have changed. Inherited from Control.
Unloaded	Occurs when the control is removed from the visual tree. Inherited from Control.
ContextCanceled	Occurs when the context input gesture continues into another gesture, to notify the element that the context flyout should not be opened. Inherited from InputElement.
ContextRequested	Occurs when the user has completed a context input gesture, such as a right-click. Inherited from InputElement.
DoubleTapped	Occurs when the user briefly contacts and releases twice on a single point, without significant movement. Inherited from InputElement.
GettingFocus	Occurs before the control receives focus. Inherited from InputElement.
GotFocus	Occurs when the control receives focus. Inherited from InputElement.
Holding	Occurs when the user makes a single contact, then maintains contact beyond a given time threshold without releasing or making another contact. Inherited from InputElement.
KeyDown	Occurs when a key is pressed while the control has focus. Inherited from InputElement.
KeyUp	Occurs when a key is released while the control has focus. Inherited from InputElement.
LosingFocus	Occurs before the control loses focus. Inherited from InputElement.
LostFocus	Occurs when the control loses focus. Inherited from InputElement.
Pinch	Occurs when the user moves two contact points closer together. Inherited from InputElement.
PinchEnded	Occurs when the user releases both contact points used in a pinch gesture. Inherited from InputElement.
PointerCaptureLost	Occurs when the control or its child control loses the pointer capture for any reason, event will not be triggered for a parent control if capture was transferred to another child of that parent control. Inherited from InputElement.
PointerEntered	Occurs when the pointer enters the control. Inherited from InputElement.
PointerExited	Occurs when the pointer leaves the control. Inherited from InputElement.
PointerMoved	Occurs when the pointer moves over the control. Inherited from InputElement.
PointerPressed	Occurs when the pointer is pressed over the control. Inherited from InputElement.
PointerReleased	Occurs when the pointer is released over the control. Inherited from InputElement.
PointerTouchPadGestureMagnify	Occurs when the user moves two contact points away from each other on a touchpad. Inherited from InputElement.
PointerTouchPadGestureRotate	Occurs when the user places two contact points and moves them in a circular motion on a touchpad. Inherited from InputElement.
PointerTouchPadGestureSwipe	Occurs when the user performs a rapid dragging motion in a single direction on a touchpad. Inherited from InputElement.
PointerWheelChanged	Occurs when the mouse is scrolled over the control. Inherited from InputElement.
PullGesture	Occurs when the user drags from the edge of a control. Inherited from InputElement.
PullGestureEnded	Occurs when the user releases the pointer after a pull gesture. Inherited from InputElement.
RightTapped	Occurs when the user briefly contacts and releases a single point, without significant movement, using a mechanism on the input device recognized as a right button or equivalent. Inherited from InputElement.
ScrollGesture	Occurs when the user continuously moves the pointer in the same direction within the control’s boundaries. Inherited from InputElement.
ScrollGestureEnded	Occurs when a scroll gesture has fully stopped, taking into account any inertial movement that continues the scroll after the user has released the pointer. Inherited from InputElement.
ScrollGestureInertiaStarting	Occurs within a scroll gesture, when the user releases the pointer, and scrolling continues by transitioning to momentum-based gliding movement. Inherited from InputElement.
SwipeGesture	Occurs when the user rapidly drags the pointer in a single direction across the control. Inherited from InputElement.
SwipeGestureEnded	Occurs when a swipe gesture ends on the control. Inherited from InputElement.
Tapped	Occurs when the user briefly contacts and releases a single point, without significant movement. Inherited from InputElement.
TextInput	Occurs when a user typed some text while the control has focus. Inherited from InputElement.
TextInputMethodClientRequested	Occurs when an input element gains input focus and input method is looking for the corresponding client Inherited from InputElement.
EffectiveViewportChanged	Occurs when the element's effective viewport changes. Inherited from Layoutable.
LayoutUpdated	Occurs when a layout pass completes for the control. Inherited from Layoutable.
AttachedToVisualTree	Raised when the control is attached to a rooted visual tree. Inherited from Visual.
DetachedFromVisualTree	Raised when the control is detached from a rooted visual tree. Inherited from Visual.
ActualThemeVariantChanged	Raised when the theme variant is changed on the element or an ancestor of the element. Inherited from StyledElement.
AttachedToLogicalTree	Raised when the styled element is attached to a rooted logical tree. Inherited from StyledElement.
DataContextChanged	Occurs when the Avalonia.StyledElement.DataContext property changes. Inherited from StyledElement.
DetachedFromLogicalTree	Raised when the styled element is detached from a rooted logical tree. Inherited from StyledElement.
Initialized	Occurs when the styled element has finished initialization. Inherited from StyledElement.
ResourcesChanged	Occurs when a resource in this styled element or a parent styled element has changed. Inherited from StyledElement.
PropertyChanged	Raised when a Avalonia.AvaloniaProperty value changes on this object. Inherited from AvaloniaObject.

ContentChanged Event

Occurs when the document content changes.

public event EventHandler ContentChanged

Remarks

This event fires once per logical editing operation, not for each individual character. Batch operations trigger a single event.

The event is only raised when the document was actually modified; no-op change blocks (opened without edits) are suppressed.

DocumentChanged Event

Occurs when the document is replaced.

public event EventHandler DocumentChanged

Remarks

This event fires when the Avalonia.Controls.RichTextEditor.Document property changes.

IsReadOnlyChanged Event

Occurs when the Avalonia.Controls.RichTextEditor.IsReadOnly property changes.

public event EventHandler IsReadOnlyChanged

SelectionChanged Event

Occurs when the selection changes.

public event EventHandler SelectionChanged

Remarks

This event fires when the caret moves or the selection extent changes.