Class RadRichTextEditor

RadRichTextEditor is a WYSIWYG control that can display and edit HTML content.

Inheritance

System.Object

RadContentView

RadRichTextEditor

Inherited Members

RadContentView.ActualStyleClassProperty

RadContentView.OnChildAdded(Element)

RadContentView.OnChildRemoved(Element)

RadContentView.OnBindingContextChanged()

RadContentView.OnMeasure(Double, Double)

RadContentView.OnPropertyChanged(String)

RadContentView.ActualStyleClass

Namespace: Telerik.XamarinForms.RichTextEditor

Assembly: Telerik.XamarinForms.RichTextEditor.dll

Syntax

public class RadRichTextEditor : RadContentView

Constructors

RadRichTextEditor()

Declaration

public RadRichTextEditor()

Fields

AutoGenerateContextMenuProperty

Identifies the AutoGenerateContextMenu property.

Declaration

public static readonly BindableProperty AutoGenerateContextMenuProperty

Field Value

Xamarin.Forms.BindableProperty

BackgroundColorProperty

Identifies the BackgroundColor property.

Declaration

public static readonly BindableProperty BackgroundColorProperty

Field Value

Xamarin.Forms.BindableProperty

BorderColorProperty

Identifies the BorderColor property.

Declaration

public static readonly BindableProperty BorderColorProperty

Field Value

Xamarin.Forms.BindableProperty

BorderThicknessProperty

Identifies the BorderThickness property.

Declaration

public static readonly BindableProperty BorderThicknessProperty

Field Value

Xamarin.Forms.BindableProperty

BusyIndicatorContentProperty

Identifies the BusyIndicatorContent property.

Declaration

public static readonly BindableProperty BusyIndicatorContentProperty

Field Value

Xamarin.Forms.BindableProperty

BusyIndicatorTemplateProperty

Identifies the BusyIndicatorTemplate property.

Declaration

public static readonly BindableProperty BusyIndicatorTemplateProperty

Field Value

Xamarin.Forms.BindableProperty

CornerRadiusProperty

Identifies the CornerRadius property.

Declaration

public static readonly BindableProperty CornerRadiusProperty

Field Value

Xamarin.Forms.BindableProperty

FontAttributesProperty

Identifies the FontAttributes property.

Declaration

public static readonly BindableProperty FontAttributesProperty

Field Value

Xamarin.Forms.BindableProperty

FontFamilyProperty

Identifies the FontFamily property.

Declaration

public static readonly BindableProperty FontFamilyProperty

Field Value

Xamarin.Forms.BindableProperty

FontSizeProperty

Identifies the FontSize property.

Declaration

public static readonly BindableProperty FontSizeProperty

Field Value

Xamarin.Forms.BindableProperty

HighlightTextColorProperty

Identifies the HighlightTextColor property.

Declaration

public static readonly BindableProperty HighlightTextColorProperty

Field Value

Xamarin.Forms.BindableProperty

HorizontalTextAlignmentProperty

Identifies the HorizontalTextAlignment property.

Declaration

public static readonly BindableProperty HorizontalTextAlignmentProperty

Field Value

Xamarin.Forms.BindableProperty

IsBusyProperty

Identifies the IsBusy property.

Declaration

public static readonly BindableProperty IsBusyProperty

Field Value

Xamarin.Forms.BindableProperty

IsHyperlinkSelectedProperty

Identifies the IsHyperlinkSelected property.

Declaration

public static readonly BindableProperty IsHyperlinkSelectedProperty

Field Value

Xamarin.Forms.BindableProperty

IsImageSelectedProperty

Identifies the IsImageSelected property.

Declaration

public static readonly BindableProperty IsImageSelectedProperty

Field Value

Xamarin.Forms.BindableProperty

IsReadOnlyProperty

Identifies the IsReadOnly property.

Declaration

public static readonly BindableProperty IsReadOnlyProperty

Field Value

Xamarin.Forms.BindableProperty

ListTypeProperty

Identifies the ListType property.

Declaration

public static readonly BindableProperty ListTypeProperty

Field Value

Xamarin.Forms.BindableProperty

SelectionRangeProperty

Identifies the SelectionRange property.

Declaration

public static readonly BindableProperty SelectionRangeProperty

Field Value

Xamarin.Forms.BindableProperty

SourceProperty

Identifies the Source property.

Declaration

public static readonly BindableProperty SourceProperty

Field Value

Xamarin.Forms.BindableProperty

TextColorProperty

Identifies the TextColor property.

Declaration

public static readonly BindableProperty TextColorProperty

Field Value

Xamarin.Forms.BindableProperty

TextDecorationsProperty

Identifies the TextDecorations property.

Declaration

public static readonly BindableProperty TextDecorationsProperty

Field Value

Xamarin.Forms.BindableProperty

TextFormattingProperty

Identifies the TextFormatting property.

Declaration

public static readonly BindableProperty TextFormattingProperty

Field Value

Xamarin.Forms.BindableProperty

Properties

AlignCenterCommand

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

Declaration

public ICommand AlignCenterCommand { get; }

Property Value

System.Windows.Input.ICommand

AlignJustifyCommand

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

Declaration

public ICommand AlignJustifyCommand { get; }

Property Value

System.Windows.Input.ICommand

AlignLeftCommand

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

Declaration

public ICommand AlignLeftCommand { get; }

Property Value

System.Windows.Input.ICommand

AlignRightCommand

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

Declaration

public ICommand AlignRightCommand { get; }

Property Value

System.Windows.Input.ICommand

ApplyHyperlinkCommand

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

Declaration

public ICommand ApplyHyperlinkCommand { get; }

Property Value

System.Windows.Input.ICommand

AutoGenerateContextMenu

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

Declaration

public bool AutoGenerateContextMenu { get; set; }

Property Value

System.Boolean

BackgroundColor

Gets or sets the background color of the RadRichTextEditor.

Declaration

public Color BackgroundColor { get; set; }

Property Value

Xamarin.Forms.Color

BorderColor

Gets or sets the border color of the RadRichTextEditor.

Declaration

public Color BorderColor { get; set; }

Property Value

Xamarin.Forms.Color

BorderThickness

Gets or sets the border thickness of the RadRichTextEditor.

Declaration

public Thickness BorderThickness { get; set; }

Property Value

Xamarin.Forms.Thickness

BusyIndicatorContent

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

Declaration

public View BusyIndicatorContent { get; }

Property Value

Xamarin.Forms.View

BusyIndicatorTemplate

Gets or sets a Xamarin.Forms.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.

Declaration

public DataTemplate BusyIndicatorTemplate { get; set; }

Property Value

Xamarin.Forms.DataTemplate

ClearFormattingCommand

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

Declaration

public ICommand ClearFormattingCommand { get; }

Property Value

System.Windows.Input.ICommand

ContextMenuItems

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

Declaration

public IList<RichTextEditorContextMenuItemBase> ContextMenuItems { get; }

Property Value

System.Collections.Generic.IList<RichTextEditorContextMenuItemBase>

CopyCommand

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

Declaration

public ICommand CopyCommand { get; }

Property Value

System.Windows.Input.ICommand

CornerRadius

Gets or sets the corner radius of the RadRichTextEditor.

Declaration

public Thickness CornerRadius { get; set; }

Property Value

Xamarin.Forms.Thickness

CutCommand

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

Declaration

public ICommand CutCommand { get; }

Property Value

System.Windows.Input.ICommand

FontAttributes

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

Declaration

public RichTextFontAttributes FontAttributes { get; set; }

Property Value

RichTextFontAttributes

FontFamily

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

Declaration

public string FontFamily { get; set; }

Property Value

System.String

FontSize

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

Declaration

public RichTextUnit FontSize { get; set; }

Property Value

RichTextUnit

HighlightTextColor

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

Declaration

public Color HighlightTextColor { get; set; }

Property Value

Xamarin.Forms.Color

HorizontalTextAlignment

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

Declaration

public RichTextHorizontalAlignment HorizontalTextAlignment { get; set; }

Property Value

RichTextHorizontalAlignment

IndentCommand

Gets a command to indent the text in the RadRichTextEditor.

Declaration

public ICommand IndentCommand { get; }

Property Value

System.Windows.Input.ICommand

InsertImageCommand

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

Declaration

public ICommand InsertImageCommand { get; }

Property Value

System.Windows.Input.ICommand

IsBusy

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

Declaration

public bool IsBusy { get; }

Property Value

System.Boolean

IsHyperlinkSelected

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

Declaration

public bool IsHyperlinkSelected { get; }

Property Value

System.Boolean

IsImageSelected

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

Declaration

public bool IsImageSelected { get; }

Property Value

System.Boolean

IsReadOnly

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

Declaration

public bool IsReadOnly { get; set; }

Property Value

System.Boolean

ListType

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

Declaration

public RichTextListType ListType { get; set; }

Property Value

RichTextListType

OpenHyperlinkCommand

Gets a command to open a hyperlink in the RadRichTextEditor.

Declaration

public ICommand OpenHyperlinkCommand { get; }

Property Value

System.Windows.Input.ICommand

OutdentCommand

Gets a command to outdent the text in the RadRichTextEditor.

Declaration

public ICommand OutdentCommand { get; }

Property Value

System.Windows.Input.ICommand

PasteCommand

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

Declaration

public ICommand PasteCommand { get; }

Property Value

System.Windows.Input.ICommand

RedoCommand

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

Declaration

public ICommand RedoCommand { get; }

Property Value

System.Windows.Input.ICommand

RemoveHyperlinkCommand

Gets a command to remove a hyperlink in the RadRichTextEditor.

Declaration

public ICommand RemoveHyperlinkCommand { get; }

Property Value

System.Windows.Input.ICommand

RemoveImageCommand

Gets a command to remove an image in the RadRichTextEditor.

Declaration

public ICommand RemoveImageCommand { get; }

Property Value

System.Windows.Input.ICommand

SelectAllCommand

Gets a command to select all in the RadRichTextEditor.

Declaration

public ICommand SelectAllCommand { get; }

Property Value

System.Windows.Input.ICommand

SelectionRange

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

Declaration

public RichTextSelectionRange SelectionRange { get; set; }

Property Value

RichTextSelectionRange

Source

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

Declaration

public RichTextSource Source { get; set; }

Property Value

RichTextSource

TextColor

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

Declaration

public Color TextColor { get; set; }

Property Value

Xamarin.Forms.Color

TextDecorations

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

Declaration

public RichTextDecorations TextDecorations { get; set; }

Property Value

RichTextDecorations

TextFormatting

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

Declaration

public RichTextFormatting TextFormatting { get; set; }

Property Value

RichTextFormatting

ToggleBoldCommand

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

Declaration

public ICommand ToggleBoldCommand { get; }

Property Value

System.Windows.Input.ICommand

ToggleBulletingCommand

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

Declaration

public ICommand ToggleBulletingCommand { get; }

Property Value

System.Windows.Input.ICommand

ToggleItalicCommand

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

Declaration

public ICommand ToggleItalicCommand { get; }

Property Value

System.Windows.Input.ICommand

ToggleNumberingCommand

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

Declaration

public ICommand ToggleNumberingCommand { get; }

Property Value

System.Windows.Input.ICommand

ToggleStrikethroughCommand

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

Declaration

public ICommand ToggleStrikethroughCommand { get; }

Property Value

System.Windows.Input.ICommand

ToggleSubscriptCommand

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

Declaration

public ICommand ToggleSubscriptCommand { get; }

Property Value

System.Windows.Input.ICommand

ToggleSuperscriptCommand

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

Declaration

public ICommand ToggleSuperscriptCommand { get; }

Property Value

System.Windows.Input.ICommand

ToggleUnderlineCommand

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

Declaration

public ICommand ToggleUnderlineCommand { get; }

Property Value

System.Windows.Input.ICommand

UndoCommand

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

Declaration

public ICommand UndoCommand { get; }

Property Value

System.Windows.Input.ICommand

Methods

GetHtmlAsync()

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

Declaration

public Task<string> GetHtmlAsync()

Returns

System.Threading.Tasks.Task<System.String> System.Threading.Tasks.Task<> with the currently edited content as HTML.

GetHyperlinkAsync()

Gets asynchronously the hyperlink under the caret in the RadRichTextEditor.

Declaration

public Task<RichTextHyperlink> GetHyperlinkAsync()

Returns

System.Threading.Tasks.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.

Declaration

public Task<RichTextImage> GetImageAsync()

Returns

System.Threading.Tasks.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.

Declaration

public Task<RichTextSelection> GetSelectionAsync()

Returns

System.Threading.Tasks.Task<RichTextSelection> An instance of the RichTextSelection class or null, if there is no text selection.

OnSizeAllocated(Double, Double)

Declaration

protected override void OnSizeAllocated(double width, double height)

Parameters

System.Double width

System.Double height

Events

FontAttributesChanged

Raised when the FontAttributes property of the RadRichTextEditor has changed.

Declaration

public event EventHandler<RadValueChangedEventArgs<RichTextFontAttributes>> FontAttributesChanged

Event Type

System.EventHandler<RadValueChangedEventArgs<RichTextFontAttributes>>

FontFamilyChanged

Raised when the FontFamily property of the RadRichTextEditor has changed.

Declaration

public event EventHandler<RadValueChangedEventArgs<string>> FontFamilyChanged

Event Type

System.EventHandler<RadValueChangedEventArgs<System.String>>

FontSizeChanged

Raised when the FontSize property of the RadRichTextEditor has changed.

Declaration

public event EventHandler<RadValueChangedEventArgs<RichTextUnit>> FontSizeChanged

Event Type

System.EventHandler<RadValueChangedEventArgs<RichTextUnit>>

HighlightTextColorChanged

Raised when the HighlightTextColor property of the RadRichTextEditor has changed.

Declaration

public event EventHandler<RadValueChangedEventArgs<Color>> HighlightTextColorChanged

Event Type

System.EventHandler<RadValueChangedEventArgs<Xamarin.Forms.Color>>

HorizontalTextAlignmentChanged

Raised when the HorizontalTextAlignment property of the RadRichTextEditor has changed.

Declaration

public event EventHandler<RadValueChangedEventArgs<RichTextHorizontalAlignment>> HorizontalTextAlignmentChanged

Event Type

System.EventHandler<RadValueChangedEventArgs<RichTextHorizontalAlignment>>

InsertImageError

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

Declaration

public event EventHandler<InsertImageErrorEventArgs> InsertImageError

Event Type

System.EventHandler<InsertImageErrorEventArgs>

IsHyperlinkSelectedChanged

Raised when the IsHyperlinkSelected property of the RadRichTextEditor has changed.

Declaration

public event EventHandler<RadValueChangedEventArgs<bool>> IsHyperlinkSelectedChanged

Event Type

System.EventHandler<RadValueChangedEventArgs<System.Boolean>>

IsImageSelectedChanged

Raised when the IsImageSelected property of the RadRichTextEditor has changed.

Declaration

public event EventHandler<RadValueChangedEventArgs<bool>> IsImageSelectedChanged

Event Type

System.EventHandler<RadValueChangedEventArgs<System.Boolean>>

IsReadOnlyChanged

Raised when the IsReadOnly property of the RadRichTextEditor has changed.

Declaration

public event EventHandler<RadValueChangedEventArgs<bool>> IsReadOnlyChanged

Event Type

System.EventHandler<RadValueChangedEventArgs<System.Boolean>>

ListTypeChanged

Raised when the ListType property of the RadRichTextEditor has changed.

Declaration

public event EventHandler<RadValueChangedEventArgs<RichTextListType>> ListTypeChanged

Event Type

System.EventHandler<RadValueChangedEventArgs<RichTextListType>>

OpenHyperlinkError

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

Declaration

public event EventHandler<OpenHyperlinkErrorEventArgs> OpenHyperlinkError

Event Type

System.EventHandler<OpenHyperlinkErrorEventArgs>

PickImage

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

Declaration

public event EventHandler<PickImageEventArgs> PickImage

Event Type

System.EventHandler<PickImageEventArgs>

SelectionRangeChanged

Raised when the SelectionRange property of the RadRichTextEditor has changed.

Declaration

public event EventHandler<RadValueChangedEventArgs<RichTextSelectionRange>> SelectionRangeChanged

Event Type

System.EventHandler<RadValueChangedEventArgs<RichTextSelectionRange>>

TextColorChanged

Raised when the TextColor property of the RadRichTextEditor has changed.

Declaration

public event EventHandler<RadValueChangedEventArgs<Color>> TextColorChanged

Event Type

System.EventHandler<RadValueChangedEventArgs<Xamarin.Forms.Color>>

TextDecorationsChanged

Raised when the TextDecorations property of the RadRichTextEditor has changed.

Declaration

public event EventHandler<RadValueChangedEventArgs<RichTextDecorations>> TextDecorationsChanged

Event Type

System.EventHandler<RadValueChangedEventArgs<RichTextDecorations>>

TextFormattingChanged

Raised when the TextFormatting property of the RadRichTextEditor has changed.

Declaration

public event EventHandler<RadValueChangedEventArgs<RichTextFormatting>> TextFormattingChanged

Event Type

System.EventHandler<RadValueChangedEventArgs<RichTextFormatting>>