menu

Blazor

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class RichTextEditorQuickToolbarSettings - Blazor API Reference | Syncfusion

    Show / Hide Table of Contents

    Class RichTextEditorQuickToolbarSettings

    Represents the configuration settings for the quick toolbar in the SfRichTextEditor.

    Inheritance
    System.Object
    RichTextEditorQuickToolbarSettings
    Namespace: Syncfusion.Blazor.RichTextEditor
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class RichTextEditorQuickToolbarSettings : OwningComponentBase

    Constructors

    RichTextEditorQuickToolbarSettings()

    Declaration
    public RichTextEditorQuickToolbarSettings()

    Properties

    ActionOnScroll

    Gets or sets a value indicating whether the quick toolbar is hidden when scrolling the page or editor container.

    Declaration
    public ActionOnScroll ActionOnScroll { get; set; }
    Property Value
    Type Description
    ActionOnScroll

    A value from the ActionOnScroll enumeration. Default is Hide.

    Remarks
    • When Hide is set, the quick toolbar will be hidden while scrolling the page or editor container.
    • When None is set, the quick toolbar will remain visible during scrolling.

    Audio

    Gets or sets the quick toolbar items displayed when an audio element is selected.

    Declaration
    public List<AudioToolbarItemModel> Audio { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<AudioToolbarItemModel>

    A list of items of type AudioToolbarItemModel.

    Remarks

    These toolbar items facilitate interactions with audio content within the editor, enabling users to manage audio elements directly through the quick toolbar.

    Enable

    Gets or sets a value indicating whether to enable the quick toolbar in the SfRichTextEditor.

    Declaration
    public bool Enable { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if the quick toolbar is enabled; otherwise, false. The default value is true.

    Remarks

    Enabling the quick toolbar provides users with additional editing options when interacting with specific content types.

    Image

    Gets or sets the quick toolbar items that appear when an image is selected.

    Declaration
    public List<ImageToolbarItemModel> Image { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<ImageToolbarItemModel>

    A list of items of type ImageToolbarItemModel.

    Remarks

    These toolbar items provide functionality applicable to images within the editor. They allow users to perform image-related actions quickly and efficiently.

    Link

    Gets or sets the quick toolbar items shown when a hyperlink is selected.

    Declaration
    public List<LinkToolbarItemModel> Link { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<LinkToolbarItemModel>

    A list of items of type LinkToolbarItemModel.

    Remarks

    These toolbar items offer link-specific actions within the editor, providing users with fast access to link editing functionalities.

    ShowOnRightClick

    Gets or sets a value indicating whether the quick toolbar opens on right-click actions.

    Declaration
    public bool ShowOnRightClick { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if enabled, allowing the toolbar to open on right-click; default is false.

    Remarks

    This setting controls whether a right-click will display the quick toolbar over the selected content, offering a convenient method for users to access the toolbar.

    Table

    Gets or sets the quick toolbar items for table elements in the editor.

    Declaration
    public List<TableToolbarItemModel> Table { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<TableToolbarItemModel>

    A list of items of type TableToolbarItemModel.

    Remarks

    These toolbar items provide table-specific functionality, assisting users in executing table-related tasks efficiently.

    Text

    Gets or sets the quick toolbar items for when text is selected in the editor.

    Declaration
    public List<ToolbarItemModel> Text { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<ToolbarItemModel>

    A list of items of type ToolbarItemModel.

    Remarks

    These items offer various text formatting and manipulation options, allowing for immediate adjustments directly through the quick toolbar.

    Video

    Gets or sets the quick toolbar items to render when a video element is selected.

    Declaration
    public List<VideoToolbarItemModel> Video { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<VideoToolbarItemModel>

    A list of items of type VideoToolbarItemModel.

    Remarks

    These items allow for video-specific actions within the editor, aiding in the manipulation and configuration of video content.

    Methods

    Dispose()

    Disposes unmanaged resources used by the component.

    Declaration
    public virtual void Dispose()
    Remarks

    Calls the Dispose(Boolean) method to release unmanaged resources. This implementation provides cleanup logic to free resources when the component is destroyed.

    Dispose(Boolean)

    Dispose unmanaged resources in the Syncfusion Blazor component.

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

    Boolean value to dispose the object.

    OnInitializedAsync()

    Method invoked when the component is ready to start.

    Declaration
    protected override Task OnInitializedAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task

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

    OnParametersSetAsync()

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

    Declaration
    protected override Task OnParametersSetAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task

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

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