DashboardTitleEditorExtension Class
An extension that is the Web Dashboard title editor.
#Declaration
export class DashboardTitleEditorExtension extends DisposableObject implements IExtension
#Remarks
When registered, the DashboardTitleEditorExtension
adds the “Title” item to the dashboard menu.
To get access to the DashboardTitleEditorExtension
settings, call the control’s findExtension(extensionName) method and pass the extension’s name as a parameter.
var ext = dashboardControl.findExtension('dashboardTitleEditor');
To remove this item from the menu, call the unregisterExtension(extensionNames) method and pass the extension’s unique name as a parameter:
dashboardControl.unregisterExtension('dashboardTitleEditor');
You can also call the control’s option method to change the extension options.
#Implements
#Inheritance
#constructor(dashboardControl)
Initializes a new instance of the DashboardTitleEditorExtension
class.
#Declaration
constructor(
dashboardControl: DevExpress.Dashboard.DashboardControl
)
#Parameters
Name | Type | Description |
---|---|---|
dashboard |
Dashboard |
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 |
#Remarks
Use the dashboardTitleEditor
name in the following cases:
- Call the DashboardControl.findExtension method and pass the extension name as a parameter to access the extension.
- Call the control’s option method to change the extension options.
Warning
Do not change the unique name of the extension registered in the Web Dashboard to avoid exceptions.
#Methods
#dispose Method
Releases resources associated with a DashboardTitleEditorExtension
instance.
#Declaration
dispose(): void
#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