Table Manipulation in RichTextEditor
17 Dec 20225 minutes to read
The Rich Text Editor allows you to insert the table of content in the edit panel and provide options to add, edit, and remove the table as well as to perform other table-related actions. For inserting the table into the Rich Text Editor, the following list of options has been provided in the RichTextEditorTableSettings.
| Options | Description | Default Value |
|---|---|---|
| MinWidth | Sets the default minWidth of the table. | 0 |
| MaxWidth | Sets the default maxWidth of the table. | null |
| EnableResize | Enables resize feature in table. | true |
| Styles | This is an array of key value pair, on each pair, key should be name of styling and value is class name. This list will be shown on quick toolbar options to change the styles of table on designing like dashed, double bordered. | List<DropDownItemModel> |
| Width | Sets the default width of the table. | 100% |
Insert table
Using the ToolbarCommand.CreateTable toolbar option, select a number of rows and columns to be inserted over the table grid and insert the table into the Rich Text Editor content using the mouse. Tables can also be inserted through the option in the pop-up where the number of rows and columns can be provided manually, and this is the default way in devices.
@using Syncfusion.Blazor.RichTextEditor
<SfRichTextEditor ShowCharCount="true">
<RichTextEditorToolbarSettings Items="@Tools" />
<p>The Rich Text Editor component is the WYSIWYG ('what you see is what you get') editor that provides the best user experience to create and update content. Users can format their content using standard toolbar commands.</p>
</SfRichTextEditor>
@code{
private List<ToolbarItemModel> Tools = new List<ToolbarItemModel>()
{
new ToolbarItemModel() { Command = ToolbarCommand.CreateTable }
};
}
Quick Toolbar
The quick toolbar is opened by clicking the table. It has different sets of commands to be performed on the table, which increases the feasibility of editing the table easily.
NOTE
For more details about quick toolbar, refer to this documentation section.
Table properties
Sets the default width of the table when it is inserted in the Rich Text Editor using the width of the RichTextEditorTableSettings.
Using the quick toolbar, users can change the width, cell padding, and cell spacing in the selected table using the TableToolbarCommand.TableEditProperties command dialog action.
The TableToolbarCommand.TableCell item should be configured in the RichTextEditorQuickToolbarSettings.Table property to show the merge or split icons while selecting the table cells.
Cell merge and split
The Rich Text Editor allows users to change the appearance of the tables by splitting or merging the table cells.
The TableCell item should be configured in the Table quickToolbarSettings property to show the merge or split icons while selecting the table cells.
Cell merging
The table cell merge feature allows the merging of two or more rows and columns of cells into a single cell with its contents.
Cell splitting
The table cell split feature allows the selected cell to be split both horizontally and vertically.
Table header
The TableToolbarCommand.TableHeader command is available with the quick toolbar option through which the header row can be added or removed from the inserted table. The following image illustrates the table header.
Insert rows
The TableCommandsArgs.Rows can be inserted above or under the required table cell through the quick toolbar. Also, the focused row can be deleted.
Insert columns
The TableCommandsArgs.Columns can be inserted to the left or right side of the required table cell through the quick toolbar. Also, the focused column can be deleted. The following screenshot shows the available options of the column item.
Vertical align
The text inside the table can be aligned to the top, middle, or bottom using the TableToolbarCommand.TableCellVerticalAlign command of the quick toolbar.
Horizontal align
The text inside the table can be aligned left, right, or center using the TableCellHorizontalAlign command of the quick toolbar.
Border Styles
Table styles provided for the class name should be appended to a table element. It helps to design the table in specific CSS styles when inserted in the editor.
By default, it provides Dashed border and Alternate rows.
Dashed border: Applies the dashed border to the table.
Alternate border: Applies the alternative background to the table.
Custom Styles
The Rich Text Editor provides support to custom styles for tables. If you want to add additional styles, pass the styles information as List<DropDownItemModel> data to the RichTextEditorTableSettings.Styles property.
@using Syncfusion.Blazor.RichTextEditor
<SfRichTextEditor>
<RichTextEditorTableSettings Styles="@StyleItems" />
<RichTextEditorToolbarSettings Items="@Tools" />
</SfRichTextEditor>
@code{
private List<ToolbarItemModel> Tools = new List<ToolbarItemModel>()
{
new ToolbarItemModel() { Command = ToolbarCommand.CreateTable }
};
private List<DropDownItemModel> StyleItems = new List<DropDownItemModel>()
{
new DropDownItemModel() { Text = "Alternate Rows" }
};
}
Cell Color
The background color can be set for each table cell through the TableToolbarCommand.BackgroundColor command available with the quick toolbar.
NOTE
Refer to the Blazor Rich Text Editor feature tour page for its groundbreaking feature representations. Also, explore the Blazor Rich Text Editor example to know how to render and configure the rich text editor tools.