menu

Blazor

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class RichTextEditorFormat - API Reference

    Show / Hide Table of Contents

    Class RichTextEditorFormat

    A class used for configuring the paragraph format properties in the SfRichTextEditor component.

    Inheritance
    System.Object
    DropDownButtonItemBase
    RichTextEditorFormat
    Inherited Members
    DropDownButtonItemBase.OnInitializedAsync()
    DropDownButtonItemBase.OnParametersSetAsync()
    DropDownButtonItemBase.Parent
    DropDownButtonItemBase.Default
    Namespace: Syncfusion.Blazor.RichTextEditor
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class RichTextEditorFormat : DropDownButtonItemBase
    Remarks

    You can configure the paragraph format tool appearance by specifying the value for the corresponding property.

    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 format that diaply under the Format tool button in the SfRichTextEditor toolbar.

    Declaration
    public override List<DropDownItemModel> Items { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<DropDownItemModel>

    DropDownItemModel

    Overrides
    DropDownButtonItemBase.Items

    Width

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

    Declaration
    public override string Width { get; set; }
    Property Value
    Type Description
    System.String

    This property contains wisth value as string. The default value is 65px.

    Overrides
    DropDownButtonItemBase.Width

    Methods

    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.

    Overrides
    DropDownButtonItemBase.Dispose(Boolean)

    GetDropDownType()

    Used to get the dropdown type.

    Declaration
    protected override string GetDropDownType()
    Returns
    Type Description
    System.String

    Returns the dropdown type.

    Overrides
    DropDownButtonItemBase.GetDropDownType()

    PropertyChangeHandler(Dictionary<String, Object>.KeyCollection)

    Used to handle the dynamic property changes.

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

    Specifies the changed keys.

    Overrides
    DropDownButtonItemBase.PropertyChangeHandler(Dictionary<String, Object>.KeyCollection)
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved