DashboardViewerApiOptionBuilder.OnItemCaptionToolbarUpdated(String) Method
Specifies the JavaScript function (or its name) executed before the dashboard item caption toolbar is updated.
Namespace: DevExpress.DashboardAspNetCore
Assembly: DevExpress.Dashboard.v24.2.AspNetCore.dll
Declaration
public DashboardViewerApiOptionBuilder OnItemCaptionToolbarUpdated(
string onItemCaptionToolbarUpdated
)Parameters
| Name | Type | Description |
|---|---|---|
| onItemCaptionToolbarUpdated | String | The JavaScript function (or its name) executed when the event is raised. |
Returns
| Type | Description |
|---|---|
| DashboardViewerApiOptionBuilder | A reference to this instance after the operation has completed. |
Remarks
Handle the ItemCaptionToolbarUpdated event to customize the dashboard item’s caption. For instance, you can add custom command buttons, create additional menus, add static texts, etc. The DashboardItemCaptionToolbarOptions class contains options used to customize a dashboard item caption’s elements (the ViewerToolbarItem objects).
Note
The corresponding DashboardControl’s API: ViewerApiExtensionOptions.onItemCaptionToolbarUpdated.
The following example shows how to handle the ItemCaptionToolbarUpdated event to add a popup menu to the dashboard item caption. The menu allows users to switch between Chart items with different settings.