Enable Text Editor Functionality

Apr 27, 2021
5 minutes to read

The Web Dashboard supports Rich Text Editor to edit the Text Box item’s content: add data items, format and edit characters, paragraphs, lists, tables and so on.

You need to enable the Rich Edit control functionality before use.

ASP.NET Web Forms

Set the ASPxDashboard.EnableTextBoxItemEditor property to true.

<dx:ASPxDashboard ID="ASPxDashboard1" runat="server" EnableTextBoxItemEditor="true">
</dx:ASPxDashboard>

ASP.NET MVC

Add the ClientRichEdit scripts and styles required for Rich Edit.

<head>
    <meta charset="UTF-8" />
    <title>Dashboard Web Application</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" />

    @Html.DevExpress().GetStyleSheets(
        new StyleSheet { ExtensionSuite = ExtensionSuite.Dashboard },
        new StyleSheet { ExtensionSuite = ExtensionSuite.ClientRichEdit }
    )
    @Html.DevExpress().GetScripts( 
        new Script { ExtensionSuite = ExtensionSuite.Dashboard },
        new Script { ExtensionSuite = ExtensionSuite.ClientRichEdit }
    )
</head>

Pass the TextBoxItemEditorExtension instance as the DashboardControl.registerExtension method parameter before the Web Dashboard control is rendered:

function onBeforeRender(sender) {
    var control = sender.GetDashboardControl();
    control.registerExtension(new DevExpress.Dashboard.Designer.TextBoxItemEditorExtension(control));
}

ASP.NET Core

Install the devexpress-richedit npm package in addition to scripts the Web Dashboard requires.
```
npm i devexpress-richedit
```
Note
Rich Edit requires the JSZip library. Make sure you have jszip npm package installed.

Add Rich Edit’s scripts and styles and the JSZip library to the bundleconfig.json file in the following order:

[
    {
        "outputFileName": "wwwroot/css/site.min.css",
        "inputFiles": [
            ...
            "node_modules/devextreme/dist/css/dx.light.css",
            "node_modules/devexpress-richedit/dist/dx.richedit.css",
            "node_modules/@devexpress/analytics-core/dist/css/dx-analytics.common.css",
            ...
        ],
        "minify": { "enabled": false, "adjustRelativePaths": false }
    },
    {
        "outputFileName": "wwwroot/js/site.min.js",
        "inputFiles": [
            ...
            "node_modules/jszip/dist/jszip.min.js",
            "node_modules/devextreme/dist/js/dx.all.js",
            "node_modules/devexpress-richedit/dist/dx.richedit.min.js",
            "node_modules/@devexpress/analytics-core/dist/js/dx-analytics-core.min.js",
            ...
        ],
        ...
    }
]

Important

The order of attachment is important. You should add scripts and styles in the following order: DevExtreme Libraries, Rich Edit, DevExpress Analytics Components, Dashboard.

Add the Rich Edit’s icon fonts to the libman.json file to copy them to the application’s static content folder. If this file does not exist, create it in the root directory of the project next to the bundleconfig.json and package.json files:

{
"version": "1.0",
"defaultProvider": "filesystem",
"libraries": [
    {
    "library": "node_modules/devextreme/dist/css/icons/",
    "destination": "wwwroot/css/icons/",
    "files": [
        "dxicons.ttf",
        "dxicons.woff",
        "dxicons.woff2"
    ]
    },
    {
    "library": "node_modules/devexpress-richedit/dist/icons/",
    "destination": "wwwroot/css/icons/",
    "files": [
        "dxre-icons.ttf",
        "dxre-icons.woff",
        "dxre-icons.woff2"
    ]
    }
]
}

Note

This step requires the Microsoft.Web.LibraryManager.Build NuGet package to be installed.

Pass the TextBoxItemEditorExtension instance as the DashboardControl.registerExtension method parameter before the Web Dashboard control is rendered:

function onBeforeRender(dashboardControl) {
    dashboardControl.registerExtension(new DevExpress.Dashboard.Designer.TextBoxItemEditorExtension(dashboardControl));
}

HTML JavaScript Dashboard (Modular Approach)

Install the devexpress-richedit npm package in addition to scripts the Web Dashboard requires.
```
npm i devexpress-richedit
```
Note
Rich Edit requires the JSZip library. Make sure you have jszip npm package installed.

Import the TextBoxItemEditorExtension module and pass the TextBoxItemEditorExtension instance as the DashboardControl.registerExtension method parameter before the Web Dashboard control is rendered:

import { Component, AfterViewInit, ElementRef, OnDestroy } from '@angular/core';
import { DashboardControl, ResourceManager } from 'devexpress-dashboard';
import {TextBoxItemEditorExtension} from 'devexpress-dashboard/designer/text-box-item-editor-extension';

@Component({
selector: 'app-dashboard',
templateUrl: './dashboard.component.html',
styleUrls: ['./dashboard.component.css']
})

export class DashboardComponent implements AfterViewInit, OnDestroy {
    private dashboardControl!: DashboardControl;
    constructor(private element: ElementRef) {       
        ResourceManager.embedBundledResources();
    }
    ngAfterViewInit(): void {
        this.dashboardControl = new DashboardControl(this.element.nativeElement.querySelector(".dashboard-container"), {
            endpoint: "https://demos.devexpress.com/services/dashboard/api",
            workingMode: "Designer"
        });
        // Register the Text Box item editor extension.
        this.dashboardControl.registerExtension(new TextBoxItemEditorExtension(this.dashboardControl));
        this.dashboardControl.render();
    }
    ngOnDestroy(): void {
        this.dashboardControl && this.dashboardControl.dispose();
    }
}

import React from 'react';
import { DashboardControl, ResourceManager } from 'devexpress-dashboard';
import {TextBoxItemEditorExtension} from 'devexpress-dashboard/designer/text-box-item-editor-extension';


class DashboardComponent extends React.Component {
    constructor(props) {
        super(props);
        ResourceManager.embedBundledResources();
    }

    componentDidMount() {
        this.dashboardControl = new DashboardControl(this.refs.dashboardcontainer,  {          
            endpoint: "https://demos.devexpress.com/services/dashboard/api",
            workingMode: "Designer",
        });

        // Register the Text Box item editor extension.
        this.dashboardControl.registerExtension(new TextBoxItemEditorExtension(this.dashboardControl));
        this.dashboardControl.render();
    }

    componentWillUnmount() {
        this.dashboardControl.dispose();
    }

    render() {
        return (
            <div ref="dashboardcontainer" style={{ width: '100%', height: '100%' }}></div>
        );
    }
}

export default DashboardComponent;

<template>
    <div v-bind:id="componentId" style="position: absolute; left: 0; right: 0; top: 0; bottom: 0">
    </div>
</template>

<script>
import { DashboardControl, ResourceManager } from 'devexpress-dashboard';
import {TextBoxItemEditorExtension} from 'devexpress-dashboard/designer/text-box-item-editor-extension';

export default {
    name: 'DashboardComponent',
        props: {
            componentId: String
        },
    mounted () {

        ResourceManager.embedBundledResources();

        this.dashboardControl = new DashboardControl(document.getElementById(this.componentId),  {          
            endpoint: "https://demos.devexpress.com/services/dashboard/api",
            workingMode: "Designer"              
        });
        // Register the Text Box item editor extension.
        this.dashboardControl.registerExtension(new TextBoxItemEditorExtension(this.dashboardControl));
        this.dashboardControl.render();
    },
    beforeDestroy() {
        this.dashboardControl.dispose();
    },
}
</script>

Add the Rich Edit’s styles:

@import url("../node_modules/devextreme/dist/css/dx.light.css");
@import url("../node_modules/devexpress-richedit/dist/dx.richedit.css");
@import url("../node_modules/@devexpress/analytics-core/dist/css/dx-analytics.common.css");

HTML JavaScript Dashboard (Global Namespaces)

Install the devexpress-richedit npm package.
```
npm i devexpress-richedit
```
Note
Rich Edit requires the JSZip library. Make sure you have jszip npm package installed.

Attach Rich Edit’s scripts and styles and the JSZip library to the project inside the <head> section in the following order:

<head>
    <!-- ... -->        
    <link href="node_modules/devextreme/dist/css/dx.light.css" rel="stylesheet" />
    <link href="node_modules/devexpress-richedit/dist/dx.richedit.css" rel="stylesheet" />
    <link href="node_modules/@devexpress/analytics-core/dist/css/dx-analytics.common.css" rel="stylesheet" />
    <!-- ... -->
    <script src="node_modules/ace-builds/src-min-noconflict/theme-ambiance.js"></script>
    <script src="node_modules/jszip/dist/jszip.min.js"></script>
    <script src="node_modules/devextreme/dist/js/dx.all.js"></script>
    <script src="node_modules/devexpress-richedit/dist/dx.richedit.min.js"></script>
    <script src="node_modules/@devexpress/analytics-core/dist/js/dx-analytics-core.min.js"></script>
    <!-- ... -->
</head>

Tip

A full list of scripts and styles required for the Web Dashboard you can find here: Required Client Libraries - Global Namespaces.

Important

The order of attachment is important. You should add scripts and styles in the following order: DevExtreme Libraries, Rich Edit, DevExpress Analytics Components, Dashboard.

Pass the TextBoxItemEditorExtension instance as the DashboardControl.registerExtension method parameter before the Web Dashboard control is rendered:

<script>
    window.onload = function () {
        DevExpress.Dashboard.ResourceManager.embedBundledResources();
        var dashboardControl = new DevExpress.Dashboard.DashboardControl(document.getElementById("web-dashboard"), {
            endpoint: "/dashboardControl"
        });
        // Register the Text Box Item Editor extension.
        dashboardControl.registerExtension(new DevExpress.Dashboard.Designer.TextBoxItemEditorExtension(dashboardControl));
        dashboardControl.render();
    };
</script>

Controls

Tools

Controls and Extensions

Tools

Maintenance Mode

Controls

Tools

Controls and Extensions

Tools

Maintenance Mode

ASP.NET Web Forms

ASP.NET MVC

ASP.NET Core

HTML JavaScript Dashboard (Modular Approach)

HTML JavaScript Dashboard (Global Namespaces)