Class RichTextEditorToolbarSettings

A class used for configuring the ToolbarSettings properties in the Rich Text Editor.

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

Constructors

RichTextEditorToolbarSettings()

Declaration
public RichTextEditorToolbarSettings()

Properties

Enable

Specifies whether to render the toolbar in the Rich Text Editor.

Declaration
[Parameter]
public bool Enable { get; set; }
Property Value
Type Description
bool

true enables the toolbar, false disables it. Default is true.
Remarks

If enabled, the rich text toolbar is displayed, providing editing controls.

EnableFloating

Specifies whether to enable or disable the floating toolbar.

Declaration
[Parameter]
public bool EnableFloating { get; set; }
Property Value
Type Description
bool

true enables the floating toolbar; default is true.
Remarks

When floating is enabled, the toolbar remains visible as the user scrolls through the editor's content.

Items

An array of objects that is used to configure the toolbar items.

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

A list of ToolbarItemModel defining the toolbar items.
Remarks

The toolbar items are configurable and determine which tools are available to the user.

Position

Specifies the position of the toolbar in the Rich Text Editor.

Declaration
[Parameter]
public ToolbarPosition Position { get; set; }
Property Value
Type Description
ToolbarPosition

A value from the ToolbarPosition enumeration. Default is Top.
Remarks

The toolbar can be positioned either at the top or bottom of the editor content area.

Type

Specifies the types of toolbar display.

Declaration
[Parameter]
public ToolbarType Type { get; set; }
Property Value
Type Description
ToolbarType

A value from the ToolbarType enumeration.
Remarks

ToolbarType defines how toolbar items are displayed: Expand, MultiRow, or Scrollable.

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
RenderTreeBuilder __builder
Overrides

OnInitializedAsync()

Method invoked when the component is ready to start.

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
Task

A System.Threading.Tasks.Task representing any asynchronous operation.
Overrides

OnParametersSetAsync()

Method invoked when the component has received parameters from its parent.

Declaration
protected override Task OnParametersSetAsync()
Returns
Type Description
Task

A System.Threading.Tasks.Task representing any asynchronous operation.
Overrides

Implements