Class RichTextEditorFormat

A class used for configuring the paragraph format properties in the SfRichTextEditor component. Provides customization options for the paragraph formatting tool in the editor's toolbar.

Inheritance
object
ComponentBase
OwningComponentBase
SfOwningComponentBase
SfBaseComponent
DropDownButtonItemBase
RichTextEditorFormat
Implements
Inherited Members
Namespace: Syncfusion.Blazor.RichTextEditor
Assembly: Syncfusion.Blazor.dll
Syntax
public class RichTextEditorFormat : DropDownButtonItemBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable
Remarks

You can configure the paragraph format tool appearance by specifying the appropriate properties, allowing for versatile text formatting capabilities within the editor.

Examples
@using Syncfusion.Blazor.RichTextEditor;
<SfRichTextEditor>
    <RichTextEditorToolbarSettings Items = "@Tools" />
    <RichTextEditorFormat Items="FormatItems" Default="Paragraph" Width="70px"/>
</SfRichTextEditor>
@code {
    private List<ToolbarItemModel> Tools = new List<ToolbarItemModel>()
    {
        new ToolbarItemModel() { Command = ToolbarCommand.Formats }
    };
   private List<DropDownItemModel> FormatItems = new List<DropDownItemModel>()
   {
       new DropDownItemModel() { Text = "Paragraph", Value = "P" },
       new DropDownItemModel() { Text = "Heading 1", Value = "H1" },
       new DropDownItemModel() { Text = "Heading 2", Value = "H2" }
   };
}

Constructors

RichTextEditorFormat()

Declaration
public RichTextEditorFormat()

Properties

Items

Gets or sets the paragraph formats displayed under the Format tool button in the SfRichTextEditor toolbar.

Declaration
[Parameter]
public override List<DropDownItemModel>? Items { get; set; }
Property Value
Type Description
List<DropDownItemModel>

A List<T> containing available paragraph format options.
Overrides
Remarks

This collection allows users to define paragraph structures such as headings and body text, facilitating organized and aesthetically pleasing text arrangements.

Width

Gets or sets the width of the paragraph format dropdown button in the SfRichTextEditor toolbar.

Declaration
[Parameter]
public override string? Width { get; set; }
Property Value
Type Description
string

A string representing the width of the dropdown button. The default value is 65px.
Overrides
Remarks

This property affects how the paragraph format button fits within the toolbar, ensuring a sleek and efficient interface design that accommodates user interactions smoothly.

Methods

Dispose(bool)

Dispose unmanaged resources in the Syncfusion Blazor component.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing

Boolean value to dispose the object.
Overrides

GetDropDownType()

Used to get the dropdown type.

Declaration
protected override string GetDropDownType()
Returns
Type Description
string

Returns the dropdown type.
Overrides

PropertyChangeHandler(KeyCollection)

Used to handle the dynamic property changes.

Declaration
protected override void PropertyChangeHandler(Dictionary<string, object>.KeyCollection keys)
Parameters
Type Name Description
Dictionary<string, object>.KeyCollection keys

Specifies the changed keys.
Overrides

Implements