TextBoxItemEditorExtension Class

A Web Dashboard extension that allows you to edit the Text Box item’s content.

Declaration

export class TextBoxItemEditorExtension extends DisposableObject implements IExtension

Remarks

When registered, the TextBoxItemEditorExtension adds the Edit Text button that invokes the Rich Text Editor. The button is available in two locations:

The dashboard item’s Options menu

The data item’s menu

See the following topic for information on how to enable the Text Editor functionality on different platforms: Enable Text Editor Functionality.

Implements

IExtension

Inherited Members

dispose

Inheritance

DisposableObject

TextBoxItemEditorExtension

constructor(dashboardControl)

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

Declaration

constructor(
    dashboardControl: DevExpress.Dashboard.DashboardControl
)

Parameters

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

Properties

name Property

Specifies the unique extension name.

Declaration

name: string

Property Value

Type	Description
string	The unique extension name. The return value is ‘textBoxItemEditor’.

Remarks

Warning

Do not change the unique name of the extension registered in the Web Dashboard 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