Dashboard.UserData Property

Gets or sets custom data to be saved to the dashboard XML definition.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v20.2.Core.dll

NuGet Packages: DevExpress.Dashboard.Core, DevExpress.WindowsDesktop.Dashboard.Core

Declaration

C#

[Browsable(false)]
public XElement UserData { get; set; }

VB.NET

<Browsable(False)>
Public Property UserData As XElement

Property Value

Type	Description
XElement	A XElement object that specifies the XML element.

Remarks

The UserData mechanism is an obsolete approach. From v.20.1, use Custom Properties to save data to the dashboard XML definition. Instead of UserData, you can save custom data not only for a dashboard, but also for dashboard items and its data items.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the UserData property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

mvc-dashboard-how-to-store-and-edit-additional-information-with-the-dashboard-t562011/CS/MVC_WebDashboard/Models/CustomDashbboardStorage.cs#L20

XElement userData = new XElement("Root", new XElement("Parameter", parameter));
dashboard.UserData = userData;
dashboard.SaveToXml(dashboardPath);

winforms-dashboard-save-restore-dashboard-state/CS/WinFormsDashboard_DashboardState/Form1.cs#L44

{
    XElement data = e.Dashboard.UserData;
    if (data != null)

winforms-designer-save-and-apply-dashboard-state/CS/WinDesignerDashboardState/DesignerForm1.cs#L21

DevExpress.DashboardWin.DashboardLoadedEventArgs e) {
XElement data = e.Dashboard.UserData;
if(data != null) {

winforms-viewer-save-and-apply-dashboard-state/CS/WinFormsViewerSaveAndApplyDashboarState/ViewerForm1.cs#L22

DevExpress.DashboardWin.DashboardLoadedEventArgs e) {
XElement data = e.Dashboard.UserData;
    if(data != null) {

how-to-save-current-parameter-values-to-a-dashboard-xml-definition-t146533/CS/Dashboard_UserData/Form1.cs#L41

dashboard.UserData = xml;
dashboard.SaveToXml(@"..\..\Data\Dashboard.xml");

VB.NET

how-to-save-current-parameter-values-to-a-dashboard-xml-definition-t146533/VB/Dashboard_UserData/Form1.vb#L42

dashboard.UserData = xml
dashboard.SaveToXml("..\..\Data\Dashboard.xml")

mvc-dashboard-how-to-store-and-edit-additional-information-with-the-dashboard-t562011/VB/MVC_WebDashboard/Models/CustomDashbboardStorage.vb#L22

Dim userData As New XElement("Root", New XElement("Parameter", parameter))
dashboard.UserData = userData
dashboard.SaveToXml(dashboardPath)

winforms-dashboard-save-restore-dashboard-state/VB/WinFormsDashboard_DashboardState/Form1.vb#L39

Private Sub DashboardViewer1_DashboardLoaded(ByVal sender As Object, ByVal e As DevExpress.DashboardWin.DashboardLoadedEventArgs)
    Dim data As XElement = e.Dashboard.UserData
    If data IsNot Nothing Then

winforms-designer-save-and-apply-dashboard-state/VB/WinDesignerDashboardState/DesignerForm1.vb#L20

Private Sub dashboardDesigner_DashboardLoaded(ByVal sender As Object, ByVal e As DevExpress.DashboardWin.DashboardLoadedEventArgs)
    Dim data As XElement = e.Dashboard.UserData
    If data IsNot Nothing Then

winforms-viewer-save-and-apply-dashboard-state/VB/WinFormsViewerSaveAndApplyDashboarState/ViewerForm1.vb#L21

Private Sub dashboardViewer_DashboardLoaded(ByVal sender As Object, ByVal e As DevExpress.DashboardWin.DashboardLoadedEventArgs)
    Dim data As XElement = e.Dashboard.UserData
        If data IsNot Nothing Then