TextBoxItemEditorExtension Class

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

Declaration

export class TextBoxItemEditorExtension extends DisposableObject implements ISupportOptionExtension<TextBoxItemEditorExtensionOptions>

Remarks

The following topic shows how to enable Text Editor functionality on different platforms: Enable Text Editor Functionality.

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

The dashboard item’s Options menu

The data item’s menu

To configure and customize the extension, refer to the TextBoxItemEditorExtensionOptions class that contains options of the Text Box extension.

See the following topic for information on how to use the DashboardControl’s client-side API: Extensions Overview.

Implements

ISupportOptionExtension

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,
    options?: TextBoxItemEditorExtensionOptions
)

Parameters

Name	Type	Description
dashboardControl	DashboardControl	A Web Dashboard control that owns the extension.
options	TextBoxItemEditorExtensionOptions	Options of the underlying RichEdit widget used in the Text Box dashboard item.

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.

off Property

Unsubscribes from TextBoxItemEditorExtension events.

Declaration

off: DevExpress.Dashboard.Internal.EventSubscriber<TextBoxItemEditorExtensionEvents>

Property Value

Type	Description
EventSubscriber<TextBoxItemEditorExtensionEvents>	An event subscription.

on Property

Subscribes to TextBoxItemEditorExtension events.

Declaration

on: DevExpress.Dashboard.Internal.EventSubscriber<TextBoxItemEditorExtensionEvents>

Property Value

Type	Description
EventSubscriber<TextBoxItemEditorExtensionEvents>	An event subscription.

Remarks

The extension’s on and off methods help you subscribe to and unsubscribe from events.

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