alexa
menu

MAUI

  • User Guide
  • Demos
  • Support
  • Forums
  • Download

    Show / Hide Table of Contents

    Namespace Syncfusion.Maui.RichTextEditor

    Classes

    BlockNode

    Polymorphic base for block-level nodes. Mapped to JSON via the runtime type discriminator by Syncfusion.Maui.RichTextEditor.BlockNodeConverter, which is registered on BlockNodeJson.Options. The [JsonConverter] attribute below is the second layer of defense so that any field typed as BlockNode (including EditorDocument.Children) uses the dispatcher even if the options-level registration is bypassed.

    BoldMark

    Bold mark. Wire type "bold".

    BulletListNode

    An unordered (bullet) list. The runtime emits "attrs": {} for this node, so the model intentionally exposes no Attrs property.

    CodeBlockAttrs

    Strongly typed attributes for CodeBlockNode (wire type "codeBlock"). The runtime contract preserves whitespace and the language value verbatim.

    CodeBlockNode

    A code block. Wire type is "codeBlock" — the C# name keeps the application's Code terminology while the discriminator matches the runtime contract (master prompt section 2). Typically contains a single TextNode whose Text is the code; the text MUST be preserved verbatim (whitespace, newlines, indentation).

    CodeMark

    Inline-code mark. Wire type "code".

    DocumentAttrs

    Document-level attributes. The current runtime contract always emits "attrs": {} for the document; this holder preserves the field for future expansion without storing empty-object noise.

    EditorDocument

    Root of the headless editor document tree. Wraps the top-level Children list and preserves the runtime schemaVersion, attrs, and document-level marks.

    EditorNode

    Abstract base for every node in the headless editor document tree. Every runtime node has an Id, and optional Marks.

    HeadingAttrs

    Strongly typed attributes for HeadingNode. Mirrors the runtime "attrs": { "level": 1, "align": null, "indent": 0 }.

    HeadingNode

    A heading block at a runtime-supplied level (1-6). The level is preserved verbatim by the model; emission is clamped to 1-6 in the HTML converter.

    ImageAttrs

    Strongly typed attributes for ImageNode. Limited to the five properties the application supports (master prompt section 12): src, width, height, align, indent. alt, title, display, wrap, attributes are silently dropped if they appear in runtime JSON — this class does not declare them.

    ImageNode

    An image block. Children are kept as a list to match the runtime shape (the runtime emits an empty "children" array for images, which MUST be preserved on round-trip).

    InlineNode

    Polymorphic base for inline nodes. Currently the only supported inline node type is TextNode (wire type "text"). Dispatch is performed by Syncfusion.Maui.RichTextEditor.InlineNodeConverter.

    ItalicMark

    Italic mark. Wire type "italic".

    LinkMark

    Link mark. Wire type "link". Attributes are limited to href and title only — see LinkMarkAttrs.

    LinkMarkAttrs

    Strongly typed attributes for LinkMark. Limited to href and title only (master prompt section 18). target / rel are deliberately omitted — they are not part of the C# model even if the runtime JSON contains them.

    ListItemAttrs

    Strongly typed attributes for ListItemNode. Mirrors the runtime "attrs": { "align": null }.

    ListItemNode

    A list item containing block-level content (typically paragraphs, but can contain nested lists as blocks too — see REQ-HTML-003).

    Mark

    Polymorphic base for the headless editor's inline marks. Dispatch is performed by Syncfusion.Maui.RichTextEditor.MarkConverter, which reads the runtime type discriminator and forwards to the matching concrete subclass.

    OrderedListAttrs

    Strongly typed attributes for OrderedListNode (wire type "orderedList"). The numeral style ("type") is preserved as a string because the runtime contract does not guarantee a closed set (per master prompt REQ-022).

    OrderedListNode

    An ordered (numbered) list. Wire type is "orderedList" — the C# name deliberately keeps the application's NumberedList terminology while the JSON discriminator matches the runtime contract (master prompt section 2).

    ParagraphAttrs

    Strongly typed attributes for ParagraphNode. Mirrors the runtime "attrs": { "align": null, "indent": 0 }.

    ParagraphNode

    A paragraph block. Contains a flat list of inline nodes (typically one or more TextNodes with marks).

    RichTextEditorEnterKeyBehavior

    Specifies the HTML element type generated when the Enter key is pressed in the SfRichTextEditor.

    RichTextEditorFontStyle

    Represents a font style option used in a rich text editor.

    RichTextEditorFormatChangedEventArgs

    Provides data for the FormatChanged event.

    RichTextEditorFormatType

    Represents the current formatting status of text in the RichTextEditor.

    RichTextEditorHyperlinkClickedEventArgs
    RichTextEditorImageFormat

    Save options for image in Html text.

    RichTextEditorImageRequestedEventArgs

    Event args for image inserted.

    RichTextEditorImageSource

    Represents an image source for insertion into the Rich Text Editor.

    RichTextEditorParagraphFormat

    Specifies the paragraph formatting options available in the SfRichTextEditor.

    RichTextEditorTextChangedEventArgs

    Provides data for editor text.

    RichTextEditorToolBarItemCollection
    RichTextEditorToolbarPosition

    Specifies the position of the toolbar in the SfRichTextEditor.

    RichTextEditorToolbarSettings

    Toolbar settings for customization of toolabr.

    RichTextEditorValueType

    Specifies the representation carried by the Value property.

    RichTextToolbarItem

    The RichTextToolbarItem class represents an item in the toolbar of the RichTextEditor.

    RichTextToolbarOptions

    Specifies the available toolbar options for the SfRichTextEditor.

    SfRichTextEditor

    Represents a rich text editor control that provides HTML editing capabilities with toolbar support.

    SfRichTextEditorStyles

    Initiates SfRichTextEditor class

    SfTextAlignment

    Specifies the text alignment options for paragraphs.

    StrikethroughMark

    Strikethrough mark. Wire type "strikethrough".

    SubscriptMark

    Subscript mark. Wire type "subscript".

    SuperscriptMark

    Superscript mark. Wire type "superscript".

    TableCellAttrs

    Strongly typed attributes for TableCellNode. Limited to align only (master prompt section 13). colspan, rowspan, colwidth, verticalAlign, backgroundColor, color, borderColor are deliberately omitted — the application does not support them.

    TableCellNode

    A table cell. Attributes are limited to align only (master prompt section 13). The application does NOT support a separate TableHeaderNode — table header rows are emitted as td alongside data rows.

    TableChangedAction

    Specifies the type of change that occurred to a table within the RichTextEditor.

    TableChangedEventArgs
    TableNode

    A table block. The runtime emits "attrs": {} for this node, so the model intentionally exposes no Attrs property. Does NOT model a TableHeaderNode — see master prompt section 13.

    TableRowNode

    A table row. The runtime emits "attrs": {} for this node, so the model intentionally exposes no Attrs property.

    TextNode

    An inline text node. The Text field is preserved verbatim — leading/trailing whitespace, newlines, and HTML-special characters are NOT trimmed or normalized.

    TextStyleAttrs

    Strongly typed attributes for TextStyleMark. The runtime contract emits these values as strings (e.g. "color": null, "fontFamily": "'Courier New', monospace", "fontSize": "12px"). Only FontSize is transformed (pixel string → numeric System.Double); all other CSS values are preserved as strings to avoid silent normalization.

    TextStyleMark

    Text-style mark. Wire type "textStyle". Carries inline color / background-color / font-family / font-size attributes — see TextStyleAttrs. Renders as a single <span style="color:…;background-color:…;font-family:…;font-size:…px"> wrapper (see DECISIONS.md D16).

    UnderlineMark

    Underline mark. Wire type "underline".

    Back to top Generated by DocFX
    Copyright © 2001 - 2026 Syncfusion Inc. All Rights Reserved