TextBoxItemEditorExtension Class

A Web Dashboard extension that allows you to edit text in the Text Box dashboard item.

Declaration

export class TextBoxItemEditorExtension extends DisposableObject implements IExtension

Remarks

The TextBoxItem can use Rich Text Editor to edit the Text Box item’s content.

Install the devexpress-richedit npm package before enabling TextBoxItemEditorExtension that provides the editor functionality.

Use the following code to register the TextBoxItemEditorExtension extension before the control is rendered:

dashboardControl.registerExtension(new DevExpress.Dashboard.Designer.TextBoxItemEditorExtension(dashboardControl));

The Text Box topic contains information on how to enable the editor functionality on different platforms.

See the Extension section for information on how to use the HTML JavaScript Dashboard’s client-side API.

Implements

IDisposable

IExtension

Inherited Members

dispose

Inheritance

DisposableObject

TextBoxItemEditorExtension

constructor(dashboardControl)

Initializes a new instance of the TextBoxItemEditorExtension class with specified settings.

Declaration

constructor(
    dashboardControl: DashboardControl
)

Parameters

Name	Type	Description
dashboardControl	DashboardControl	A Web Dashboard control that owns the extension.

Properties

name Property

Specifies a unique extension name.

Declaration

name: string

Property Value

Type	Description
string	A unique extension name. The return value is ‘text-box-item-editor’.

Remarks

Warning

Do not change a unique name of the extension registered in the Web Dashboard in order to avoid exceptions.

Methods

start Method

Contains code that is executed when you register the dashboard extension.

Declaration

start(): void

stop Method

Contains code that is executed when you unregister the dashboard extension.

Declaration

stop(): void