DashboardViewer.CustomizeDashboardTitleText Event

OBSOLETE

The CustomizeDashboardTitleText event is obsolete. Handle the CustomizeDashboardTitle event and use the e.Text property to specify the title text.

Allows you to customize the text displayed within the dashboard title at runtime.

Namespace: DevExpress.DashboardWin

Assembly: DevExpress.Dashboard.v24.2.Win.dll

Declaration

C#

[Browsable(false)]
[Obsolete("The CustomizeDashboardTitleText event is obsolete. Handle the CustomizeDashboardTitle event and use the e.Text property to specify the title text.")]
public event CustomizeDashboardTitleTextEventHandler CustomizeDashboardTitleText

VB.NET

<Obsolete("The CustomizeDashboardTitleText event is obsolete. Handle the CustomizeDashboardTitle event and use the e.Text property to specify the title text.")>
<Browsable(False)>
Public Event CustomizeDashboardTitleText As CustomizeDashboardTitleTextEventHandler

Event Data

The CustomizeDashboardTitleText event's data class is CustomizeDashboardTitleTextEventArgs. The following properties provide information specific to this event:

Property	Description
Text	Gets or sets the text displayed within the dashboard title.

Remarks

Note

The DashboardViewer.CustomizeDashboardTitleText event is obsolete, use the DashboardViewer.CustomizeDashboardTitle event. It provides the event’s data using the CustomizeDashboardTitleEventArgs class instance.

The DashboardViewer.CustomizeDashboardTitleText event occurs in the following cases:

• An end-user performs an operation that affects the dashboard state (applies master filtering, performs drill-down or changes the parameter value).
• The dashboard object model (the DashboardViewer.Dashboard property) is changed in code.

The CustomizeDashboardTitleTextEventArgs.Text event parameter returns the default text specified for the dashboard title (DashboardTitle.Text) and allows you to specify the custom text to be displayed.

Note that changing the CustomizeDashboardTitleTextEventArgs.Text property does not change the title text specified using DashboardTitle.Text.