All docs
V20.1
20.1
19.2
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

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:

See the topic below for information on how to enable the Text Editor functionality on different platforms.

Implements

Inherited Members

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 The unique extension name.

Declaration

name: string

Property Value

Type Description
string

The unique extension name. The return value is 'text-box-item-editor'.

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