Back to all docs
API Reference / Telerik.Maui.Controls / RadRichTextEditor
New to Telerik UI for .NET MAUI? Start a free 30-day trial

RadRichTextEditor

Class

A comprehensive rich text editor control for .NET MAUI applications that provides WYSIWYG (What You See Is What You Get) editing capabilities for HTML content. The RadRichTextEditor offers an intuitive interface for creating, editing, and formatting rich text documents with extensive formatting options and multimedia support.

The RadRichTextEditor is designed to provide a user-friendly rich text editing experience with professional-grade formatting capabilities. It supports both programmatic manipulation and user interaction through an intuitive interface that adapts to different platforms and input methods.

Core Features:

  • HTML Content Support: Native HTML editing with seamless conversion to and from HTML format
  • Rich Text Formatting: Comprehensive text styling including fonts, colors, sizes, and decorations
  • Document Structure: Support for paragraphs, headings, lists, and text alignment options
  • Media Integration: Image insertion and management with size and positioning controls
  • Hyperlink Support: Create, edit, and navigate hyperlinks within documents

Text Formatting:

  • Font Properties: Font family, size, bold, italic, underline, strikethrough
  • Advanced Formatting: Subscript, superscript, text and highlight colors
  • Paragraph Formatting: Text alignment (left, center, right, justify), indentation
  • Lists: Bulleted and numbered lists with automatic formatting
  • Formatting Tools: Clear formatting, undo/redo operations

User Interface:

  • Context Menu: Customizable context menu with common editing operations
  • Selection Management: Text selection with range-based operations
  • Clipboard Operations: Cut, copy, paste with support for rich text and plain text
  • Busy Indicator: Visual feedback during long-running operations

Integration and Customization:

  • Command Support: Extensive set of built-in commands for all editing operations
  • Event Handling: Comprehensive event model for monitoring and customizing behavior
  • Styling Options: Customizable appearance with border, background, and corner radius support
  • Read-Only Mode: Display-only mode for document viewing scenarios

Ideal for applications requiring document editing, content management systems, email composition, note-taking applications, and any scenario where rich text input and formatting are needed. The control seamlessly integrates with RadRichTextEditorToolbar to provide a complete rich text editing solution with toolbar-based formatting commands.

Dedicated controls: RadRichTextEditorToolbar.

Definition

Namespace:Telerik.Maui.Controls

Assembly:Telerik.Maui.Controls.dll

Syntax:
C#
public class RadRichTextEditor : RadContentView, IRadContentView, IContentView, IView, IElement, ITransform, IPadding, ICrossPlatformLayout

Inheritance: objectRadContentViewRadRichTextEditor

Implements: IContentViewICrossPlatformLayoutIElementIPaddingIRadContentViewITransformIView...

Inherited Members RadContentView.ActualStyleClassPropertyRadContentView.OnChildAdded(Element)RadContentView.OnChildRemoved(Element, int)RadContentView.OnBindingContextChanged()RadContentView.OnHandlerChanged()

Constructors

RadRichTextEditor()

Initializes a new instance of the RadRichTextEditor class.

C#
public RadRichTextEditor()

Fields

AutoGenerateContextMenuProperty

BindableProperty

Identifies the AutoGenerateContextMenu property.

C#
public static readonly BindableProperty AutoGenerateContextMenuProperty

BackgroundColorProperty

BindableProperty

Identifies the BackgroundColor property.

C#
public static readonly BindableProperty BackgroundColorProperty

BorderColorProperty

BindableProperty

Identifies the BorderColor property.

C#
public static readonly BindableProperty BorderColorProperty

BorderThicknessProperty

BindableProperty

Identifies the BorderThickness property.

C#
public static readonly BindableProperty BorderThicknessProperty

BusyIndicatorContentProperty

BindableProperty

Identifies the BusyIndicatorContent property.

C#
public static readonly BindableProperty BusyIndicatorContentProperty

BusyIndicatorTemplateProperty

BindableProperty

Identifies the BusyIndicatorTemplate property.

C#
public static readonly BindableProperty BusyIndicatorTemplateProperty

CornerRadiusProperty

BindableProperty

Identifies the CornerRadius property.

C#
public static readonly BindableProperty CornerRadiusProperty

DefaultHyperlinkTextColorProperty

BindableProperty

Identifies the DefaultHyperlinkTextColor property.

C#
public static readonly BindableProperty DefaultHyperlinkTextColorProperty

DefaultHyperlinkVisitedTextColorProperty

BindableProperty

Identifies the DefaultHyperlinkVisitedTextColor property.

C#
public static readonly BindableProperty DefaultHyperlinkVisitedTextColorProperty

DefaultTextColorProperty

BindableProperty

Identifies the DefaultTextColor property.

C#
public static readonly BindableProperty DefaultTextColorProperty

FontAttributesProperty

BindableProperty

Identifies the FontAttributes property.

C#
public static readonly BindableProperty FontAttributesProperty

FontFamilyProperty

BindableProperty

Identifies the FontFamily property.

C#
public static readonly BindableProperty FontFamilyProperty

FontSizeProperty

BindableProperty

Identifies the FontSize property.

C#
public static readonly BindableProperty FontSizeProperty

HighlightTextColorProperty

BindableProperty

Identifies the HighlightTextColor property.

C#
public static readonly BindableProperty HighlightTextColorProperty

HorizontalTextAlignmentProperty

BindableProperty

Identifies the HorizontalTextAlignment property.

C#
public static readonly BindableProperty HorizontalTextAlignmentProperty

IsBusyProperty

BindableProperty

Identifies the IsBusy property.

C#
public static readonly BindableProperty IsBusyProperty

IsDocumentLoadedProperty

BindableProperty

Identifies the IsDocumentLoaded property.

C#
public static readonly BindableProperty IsDocumentLoadedProperty

IsHyperlinkSelectedProperty

BindableProperty

Identifies the IsHyperlinkSelected property.

C#
public static readonly BindableProperty IsHyperlinkSelectedProperty

IsImageSelectedProperty

BindableProperty

Identifies the IsImageSelected property.

C#
public static readonly BindableProperty IsImageSelectedProperty

IsReadOnlyProperty

BindableProperty

Identifies the IsReadOnly property.

C#
public static readonly BindableProperty IsReadOnlyProperty

ListTypeProperty

BindableProperty

Identifies the ListType property.

C#
public static readonly BindableProperty ListTypeProperty

SelectionRangeProperty

BindableProperty

Identifies the SelectionRange property.

C#
public static readonly BindableProperty SelectionRangeProperty

SourceProperty

BindableProperty

Identifies the Source property.

C#
public static readonly BindableProperty SourceProperty

TextColorProperty

BindableProperty

Identifies the TextColor property.

C#
public static readonly BindableProperty TextColorProperty

TextDecorationsProperty

BindableProperty

Identifies the TextDecorations property.

C#
public static readonly BindableProperty TextDecorationsProperty

TextFormattingProperty

BindableProperty

Identifies the TextFormatting property.

C#
public static readonly BindableProperty TextFormattingProperty

Properties

AlignCenterCommand

Gets a command to apply center text alignment in the RadRichTextEditor.

C#
public ICommand AlignCenterCommand { get; }

AlignJustifyCommand

Gets a command to apply justify text alignment in the RadRichTextEditor.

C#
public ICommand AlignJustifyCommand { get; }

AlignLeftCommand

Gets a command to apply left text alignment in the RadRichTextEditor.

C#
public ICommand AlignLeftCommand { get; }

AlignRightCommand

Gets a command to apply right text alignment in the RadRichTextEditor.

C#
public ICommand AlignRightCommand { get; }

ApplyHyperlinkCommand

Gets a command to apply a hyperlink in the RadRichTextEditor. The command takes a single paramerer of type RichTextHyperlink.

C#
public ICommand ApplyHyperlinkCommand { get; }

AutoGenerateContextMenu

Gets or sets a value indicating whether to auto-generate the RichTextEditorContextMenuItemBase items for the context menu for this RadRichTextEditor.

C#
public bool AutoGenerateContextMenu { get; set; }

BackgroundColor

Color

Gets or sets the background color of the RadRichTextEditor.

C#
public Color BackgroundColor { get; set; }

BorderColor

Color

Gets or sets the border color of the RadRichTextEditor.

C#
public Color BorderColor { get; set; }

BorderThickness

Thickness

Gets or sets the border thickness of the RadRichTextEditor.

C#
public Thickness BorderThickness { get; set; }

BusyIndicatorContent

View

Gets the content to show when the RadRichTextEditor is performing a long-running operation.

C#
public View BusyIndicatorContent { get; }

BusyIndicatorTemplate

DataTemplate

Gets or sets a DataTemplate to be used when displaying a busy indicator during long-running operations, e.g. when loading HTML content. When no template is specified, a default busy indicator is shown.

C#
public DataTemplate BusyIndicatorTemplate { get; set; }

ClearFormattingCommand

Gets a command to clear the formatting of the text in the RadRichTextEditor.

C#
public ICommand ClearFormattingCommand { get; }

ContextMenuItems

Gets the collection of RichTextEditorContextMenuItemBases used to generate the items of the RadRichTextEditor context menu.

C#
public IList<RichTextEditorContextMenuItemBase> ContextMenuItems { get; }

CopyCommand

Gets a command to copy the selected HTML in the RadRichTextEditor to the clipboard.

C#
public ICommand CopyCommand { get; }

CornerRadius

Thickness

Gets or sets the corner radius of the RadRichTextEditor.

C#
public Thickness CornerRadius { get; set; }

CutCommand

Gets a command to cut the selected HTML in the RadRichTextEditor to the clipboard.

C#
public ICommand CutCommand { get; }

DefaultHyperlinkTextColor

Color

Gets or sets the default text color of hyperlinks in the document of the RadRichTextEditor.

C#
public Color DefaultHyperlinkTextColor { get; set; }

This property applies a document-wide default style and does not modify the content. Hyperlink text with an explicit color keeps that color.

DefaultHyperlinkVisitedTextColor

Color

Gets or sets the default text color of visited hyperlinks in the document of the RadRichTextEditor.

C#
public Color DefaultHyperlinkVisitedTextColor { get; set; }

This property applies a document-wide default style and does not modify the content. Visited hyperlink text with an explicit color keeps that color.

DefaultTextColor

Color

Gets or sets the default Color of all text in the document of the RadRichTextEditor.

C#
public Color DefaultTextColor { get; set; }

Unlike TextColor, which applies to the current position or selection and changes the document content, this property applies a document-wide default and does not modify the content. Text that has an explicit color applied to it keeps that color. Use this property to align the document with the theme of the application, for example when switching between light and dark mode.

FontAttributes

Gets or sets the RichTextFontAttributes of the text in the RadRichTextEditor at the current position or selection.

C#
public RichTextFontAttributes FontAttributes { get; set; }

FontFamily

Gets or sets the font family of the text in the RadRichTextEditor at the current position or selection.

C#
public string FontFamily { get; set; }

FontSize

Gets or sets the font size of the text in the RadRichTextEditor at the current position or selection.

C#
public RichTextUnit FontSize { get; set; }

HighlightTextColor

Color

Gets or sets the highlight Color of the text in the RadRichTextEditor at the current position or selection.

C#
public Color HighlightTextColor { get; set; }

HorizontalTextAlignment

Gets or sets the RichTextHorizontalAlignment of the text in the RadRichTextEditor at the current position or selection.

C#
public RichTextHorizontalAlignment HorizontalTextAlignment { get; set; }

IndentCommand

Gets a command to indent the text in the RadRichTextEditor.

C#
public ICommand IndentCommand { get; }

InsertImageCommand

Gets a command to insert an image in the RadRichTextEditor. The command takes a single paramerer of type RichTextImage.

C#
public ICommand InsertImageCommand { get; }

IsBusy

Gets a value indicating whether the RadRichTextEditor is performing a long-running operation.

C#
public bool IsBusy { get; }

IsDocumentLoaded

Gets a value indicating whether a document is currently loaded in the RadRichTextEditor.

C#
public bool IsDocumentLoaded { get; }

IsHyperlinkSelected

Gets a value indicating whether a hyperlink is currently selected in the RadRichTextEditor.

C#
public bool IsHyperlinkSelected { get; }

IsImageSelected

Gets a value indicating whether an image is currently selected in the RadRichTextEditor.

C#
public bool IsImageSelected { get; }

IsReadOnly

Gets or sets a value indicating whether the RadRichTextEditor is in a read-only mode.

C#
public bool IsReadOnly { get; set; }

ListType

Gets or sets the RichTextListType of the text in the RadRichTextEditor at the current position or selection.

C#
public RichTextListType ListType { get; set; }

OpenHyperlinkCommand

Gets a command to open a hyperlink in the RadRichTextEditor.

C#
public ICommand OpenHyperlinkCommand { get; }

OutdentCommand

Gets a command to outdent the text in the RadRichTextEditor.

C#
public ICommand OutdentCommand { get; }

PasteCommand

Gets a command to paste from the clipboard to the RadRichTextEditor. The command takes a single paramerer of type RichTextPasteType.

C#
public ICommand PasteCommand { get; }

RedoCommand

Gets a command to redo the last changes in the RadRichTextEditor.

C#
public ICommand RedoCommand { get; }

RemoveHyperlinkCommand

Gets a command to remove a hyperlink in the RadRichTextEditor.

C#
public ICommand RemoveHyperlinkCommand { get; }

RemoveImageCommand

Gets a command to remove an image in the RadRichTextEditor.

C#
public ICommand RemoveImageCommand { get; }

SelectAllCommand

Gets a command to select all in the RadRichTextEditor.

C#
public ICommand SelectAllCommand { get; }

SelectionRange

Gets or sets the selection range of the text in the RadRichTextEditor.

C#
public RichTextSelectionRange SelectionRange { get; set; }

Source

Gets or sets a RichTextSource providing a rich text to the RadRichTextEditor.

C#
public RichTextSource Source { get; set; }

TextColor

Color

Gets or sets the Color of the text in the RadRichTextEditor at the current position or selection.

C#
public Color TextColor { get; set; }

TextDecorations

Gets or sets the RichTextDecorations of the text in the RadRichTextEditor at the current position or selection.

C#
public RichTextDecorations TextDecorations { get; set; }

TextFormatting

Gets or sets the RichTextFormatting of the text in the RadRichTextEditor at the current position or selection.

C#
public RichTextFormatting TextFormatting { get; set; }

ToggleBoldCommand

Gets a command to toggle the bold text style in the RadRichTextEditor.

C#
public ICommand ToggleBoldCommand { get; }

ToggleBulletingCommand

Gets a command to toggle the bullets paragraph style in the RadRichTextEditor.

C#
public ICommand ToggleBulletingCommand { get; }

ToggleItalicCommand

Gets a command to toggle the italic text style in the RadRichTextEditor.

C#
public ICommand ToggleItalicCommand { get; }

ToggleNumberingCommand

Gets a command to toggle the numbering paragraph style in the RadRichTextEditor.

C#
public ICommand ToggleNumberingCommand { get; }

ToggleStrikethroughCommand

Gets a command to toggle the strike-through text style in the RadRichTextEditor.

C#
public ICommand ToggleStrikethroughCommand { get; }

ToggleSubscriptCommand

Gets a command to toggle the subscript text style in the RadRichTextEditor.

C#
public ICommand ToggleSubscriptCommand { get; }

ToggleSuperscriptCommand

Gets a command to toggle the superscript text style in the RadRichTextEditor.

C#
public ICommand ToggleSuperscriptCommand { get; }

ToggleUnderlineCommand

Gets a command to toggle the underline text style in the RadRichTextEditor.

C#
public ICommand ToggleUnderlineCommand { get; }

UndoCommand

Gets a command to undo the last changes in the RadRichTextEditor.

C#
public ICommand UndoCommand { get; }

Methods

GetHtmlAsync()

Gets asynchronously the currently edited content of the RadRichTextEditor as HTML.

C#
public Task<string> GetHtmlAsync()
Returns:

Task<string>

Task<TResult> with the currently edited content as HTML.

GetHyperlinkAsync()

Gets asynchronously the hyperlink under the caret in the RadRichTextEditor.

C#
public Task<RichTextHyperlink> GetHyperlinkAsync()
Returns:

Task<RichTextHyperlink>

An instance of the RichTextHyperlink class or null, if there is no hyperlink.

GetImageAsync()

Gets asynchronously the currently selected image in the RadRichTextEditor.

C#
public Task<RichTextImage> GetImageAsync()
Returns:

Task<RichTextImage>

An instance of the RichTextImage class or null, if there is no image.

GetSelectionAsync()

Gets asynchronously the current text selection in the RadRichTextEditor.

C#
public Task<RichTextSelection> GetSelectionAsync()
Returns:

Task<RichTextSelection>

An instance of the RichTextSelection class or null, if there is no text selection.

OnPropertyChanged(string)

C#
protected override void OnPropertyChanged(string propertyName = null)
Parameters:propertyNamestring

Events

FontAttributesChanged

Raised when the FontAttributes property of the RadRichTextEditor has changed.

C#
public event EventHandler<ValueChangedEventArgs<RichTextFontAttributes>> FontAttributesChanged

FontFamilyChanged

Raised when the FontFamily property of the RadRichTextEditor has changed.

C#
public event EventHandler<ValueChangedEventArgs<string>> FontFamilyChanged

FontSizeChanged

Raised when the FontSize property of the RadRichTextEditor has changed.

C#
public event EventHandler<ValueChangedEventArgs<RichTextUnit>> FontSizeChanged

HighlightTextColorChanged

Raised when the HighlightTextColor property of the RadRichTextEditor has changed.

C#
public event EventHandler<ValueChangedEventArgs<Color>> HighlightTextColorChanged

HorizontalTextAlignmentChanged

Raised when the HorizontalTextAlignment property of the RadRichTextEditor has changed.

C#
public event EventHandler<ValueChangedEventArgs<RichTextHorizontalAlignment>> HorizontalTextAlignmentChanged

InsertImageError

Raised when an error occurs when inserting an image in the RadRichTextEditor.

C#
public event EventHandler<InsertImageErrorEventArgs> InsertImageError

IsHyperlinkSelectedChanged

Raised when the IsHyperlinkSelected property of the RadRichTextEditor has changed.

C#
public event EventHandler<ValueChangedEventArgs<bool>> IsHyperlinkSelectedChanged

IsImageSelectedChanged

Raised when the IsImageSelected property of the RadRichTextEditor has changed.

C#
public event EventHandler<ValueChangedEventArgs<bool>> IsImageSelectedChanged

IsReadOnlyChanged

Raised when the IsReadOnly property of the RadRichTextEditor has changed.

C#
public event EventHandler<ValueChangedEventArgs<bool>> IsReadOnlyChanged

ListTypeChanged

Raised when the ListType property of the RadRichTextEditor has changed.

C#
public event EventHandler<ValueChangedEventArgs<RichTextListType>> ListTypeChanged

OpenHyperlinkError

Raised when an error occurs when openning a hyperlink in the RadRichTextEditor.

C#
public event EventHandler<OpenHyperlinkErrorEventArgs> OpenHyperlinkError

PickImage

Raised when the user has requested to pick an image in the RadRichTextEditor.

C#
public event EventHandler<PickImageEventArgs> PickImage

SelectionRangeChanged

Raised when the SelectionRange property of the RadRichTextEditor has changed.

C#
public event EventHandler<ValueChangedEventArgs<RichTextSelectionRange>> SelectionRangeChanged

TextColorChanged

Raised when the TextColor property of the RadRichTextEditor has changed.

C#
public event EventHandler<ValueChangedEventArgs<Color>> TextColorChanged

TextDecorationsChanged

Raised when the TextDecorations property of the RadRichTextEditor has changed.

C#
public event EventHandler<ValueChangedEventArgs<RichTextDecorations>> TextDecorationsChanged

TextFormattingChanged

Raised when the TextFormatting property of the RadRichTextEditor has changed.

C#
public event EventHandler<ValueChangedEventArgs<RichTextFormatting>> TextFormattingChanged
In this article
DefinitionConstructorsRadRichTextEditor()FieldsAutoGenerateContextMenuPropertyBackgroundColorPropertyBorderColorPropertyBorderThicknessPropertyBusyIndicatorContentPropertyBusyIndicatorTemplatePropertyCornerRadiusPropertyDefaultHyperlinkTextColorPropertyDefaultHyperlinkVisitedTextColorPropertyDefaultTextColorPropertyFontAttributesPropertyFontFamilyPropertyFontSizePropertyHighlightTextColorPropertyHorizontalTextAlignmentPropertyIsBusyPropertyIsDocumentLoadedPropertyIsHyperlinkSelectedPropertyIsImageSelectedPropertyIsReadOnlyPropertyListTypePropertySelectionRangePropertySourcePropertyTextColorPropertyTextDecorationsPropertyTextFormattingPropertyPropertiesAlignCenterCommandAlignJustifyCommandAlignLeftCommandAlignRightCommandApplyHyperlinkCommandAutoGenerateContextMenuBackgroundColorBorderColorBorderThicknessBusyIndicatorContentBusyIndicatorTemplateClearFormattingCommandContextMenuItemsCopyCommandCornerRadiusCutCommandDefaultHyperlinkTextColorDefaultHyperlinkVisitedTextColorDefaultTextColorFontAttributesFontFamilyFontSizeHighlightTextColorHorizontalTextAlignmentIndentCommandInsertImageCommandIsBusyIsDocumentLoadedIsHyperlinkSelectedIsImageSelectedIsReadOnlyListTypeOpenHyperlinkCommandOutdentCommandPasteCommandRedoCommandRemoveHyperlinkCommandRemoveImageCommandSelectAllCommandSelectionRangeSourceTextColorTextDecorationsTextFormattingToggleBoldCommandToggleBulletingCommandToggleItalicCommandToggleNumberingCommandToggleStrikethroughCommandToggleSubscriptCommandToggleSuperscriptCommandToggleUnderlineCommandUndoCommandMethodsGetHtmlAsync()GetHyperlinkAsync()GetImageAsync()GetSelectionAsync()OnPropertyChanged(string)EventsFontAttributesChangedFontFamilyChangedFontSizeChangedHighlightTextColorChangedHorizontalTextAlignmentChangedInsertImageErrorIsHyperlinkSelectedChangedIsImageSelectedChangedIsReadOnlyChangedListTypeChangedOpenHyperlinkErrorPickImageSelectionRangeChangedTextColorChangedTextDecorationsChangedTextFormattingChanged
Not finding the help you need?
Contact Support