DashboardParameterDescriptor Class

Contains the parameter settings and metadata.

Namespace: DevExpress.DashboardWin

Assembly: DevExpress.Dashboard.v20.1.Win.dll

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

Declaration

C#

public class DashboardParameterDescriptor :
    IParameter,
    IFilterParameter

VB.NET

Public Class DashboardParameterDescriptor
    Implements IParameter,
               IFilterParameter

Related API Members

The following members return DashboardParameterDescriptor objects:

• DashboardParameters.Item[String]

Remarks

The DashboardParameterDescriptor class members allow you to obtain parameter settings such as the parameter type (the DashboardParameterDescriptor.Type property), the default parameter value (the DashboardParameterDescriptor.DefaultValue property), the parameter name (the DashboardParameterDescriptor.Name), etc.

The DashboardParameterDescriptor.Values property returns possible parameter values. Use the DashboardParameterDescriptor.SelectedValue/DashboardParameterDescriptor.SelectedValues properties to obtain or specify the current parameter values.

The DashboardDesigner and DashboardViewer expose the DashboardDesigner.Parameters / DashboardViewer.Parameters properties that provide access to dashboard parameter settings and metadata.

Example

The following example demonstrates how to save custom data to a dashboard XML definition using the Dashboard.UserData property.

In this example, current dashboard parameter values are saved to the dashboard XML file. Then, saved values are used to set current parameter values in the loaded dashboard.

Note

Example on GitHub: https://github.com/DevExpress-Examples/how-to-save-current-parameter-values-to-a-dashboard-xml-definition-t146533

Form1.cs

using System;
using System.Collections.Generic;
using System.Linq;
using DevExpress.XtraEditors;
using DevExpress.DashboardCommon;
using System.Xml.Linq;
using DevExpress.DashboardWin;

namespace Dashboard_UserData {
    public partial class Form1 : XtraForm {
        public Form1() {
            InitializeComponent();
            Dashboard dashboard = new Dashboard();
            dashboardViewer1.LoadDashboard(@"..\..\Data\Dashboard.xml");
        }

        private void btnSaveDashboard_Click(object sender, EventArgs e) {
            Dashboard dashboard = new Dashboard();
            dashboard.LoadFromXml(@"..\..\Data\Dashboard.xml");

            // Obtains dashboard parameter settings and metadata for a currently open dashboard.
            IList<DashboardParameterDescriptor> parameters = dashboardViewer1.Parameters;

            // Saves parameter settings and current values to an XML element.
            XElement xml = new XElement("ParametersInfo",
                        from parameter in parameters
                        select new XElement("ParameterInfo",
                                    new XElement("Name", parameter.Name),
                                    new XElement("Value", parameter.Value),
                                    new XElement("Type", parameter.Type)));

            // Adds the created XML element to the dashboard XML definition and saves the dashboard.
            dashboard.UserData = xml;
            dashboard.SaveToXml(@"..\..\Data\Dashboard.xml");
        }

        private void btnLoadDashboard_Click(object sender, EventArgs e) {
            Dashboard dashboard = new Dashboard();
            dashboard.LoadFromXml(@"..\..\Data\Dashboard.xml");

            if (dashboard.UserData != null) {
                // Obtains used data from the dashboard XML definition.
                XElement xml = dashboard.UserData;

                // Saves values from the XML element to the list.
                IList<XElement> parsInfo = xml.Elements().ToList();
                IList<object> values = new List<object>();
                foreach (XElement parInfo in parsInfo) {
                    // Converts parameter values with the 'DateTime' type to date-time values.
                    if (parInfo.Element("Type").Value == "DateTime") {
                        values.Add(DateTime.Parse(parInfo.Element("Value").Value));
                    }
                    else {
                        values.Add(parInfo.Element("Value").Value);
                    }
                }

                DashboardParameters parameters1 = dashboardViewer1.Parameters;

                // Sets obtained user values as current parameters' values.
                dashboardViewer1.BeginUpdateParameters();
                for (int i = 0; i < parameters1.Count; i++) {
                    parameters1[i].Value = values[i];
                }
                dashboardViewer1.EndUpdateParameters();
            }
        }
    }
}

Form1.vb

Imports System
Imports System.Collections.Generic
Imports System.Linq
Imports DevExpress.XtraEditors
Imports DevExpress.DashboardCommon
Imports System.Xml.Linq
Imports DevExpress.DashboardWin

Namespace Dashboard_UserData
    Partial Public Class Form1
        Inherits XtraForm

        Public Sub New()
            InitializeComponent()
            Dim dashboard As New Dashboard()
            dashboardViewer1.LoadDashboard("..\..\Data\Dashboard.xml")
        End Sub

        Private Sub btnSaveDashboard_Click(ByVal sender As Object, ByVal e As EventArgs) _
            Handles btnSaveDashboard.Click
            Dim dashboard As New Dashboard()
            dashboard.LoadFromXml("..\..\Data\Dashboard.xml")

            ' Obtains dashboard parameter settings and metadata for a currently open dashboard.
            Dim parameters As IList(Of DashboardParameterDescriptor) = dashboardViewer1.Parameters

            ' Saves parameter settings and current values to an XML element.
            Dim xml As New XElement("ParametersInfo", _
                From parameter In parameters _
                Select New XElement("ParameterInfo", New XElement("Name", parameter.Name),
                                    New XElement("Value", parameter.Value),
                                    New XElement("Type", parameter.Type)))

            ' Adds the created XML element to the dashboard XML definition and saves the dashboard.
            dashboard.UserData = xml
            dashboard.SaveToXml("..\..\Data\Dashboard.xml")
        End Sub

        Private Sub btnLoadDashboard_Click(ByVal sender As Object, ByVal e As EventArgs) _
            Handles btnLoadDashboard.Click
            Dim dashboard As New Dashboard()
            dashboard.LoadFromXml("..\..\Data\Dashboard.xml")

            If dashboard.UserData IsNot Nothing Then
                ' Obtains used data from the dashboard XML definition.
                Dim xml As XElement = dashboard.UserData

                ' Saves values from the XML element to the list.
                Dim parsInfo As IList(Of XElement) = xml.Elements().ToList()
                Dim values As IList(Of Object) = New List(Of Object)()
                For Each parInfo As XElement In parsInfo
                    ' Converts parameter values with the 'DateTime' type to date-time values.
                    If parInfo.Element("Type").Value = "DateTime" Then
                        values.Add(Date.Parse(parInfo.Element("Value").Value))
                    Else
                        values.Add(parInfo.Element("Value").Value)
                    End If
                Next parInfo

                Dim parameters1 As DashboardParameters = dashboardViewer1.Parameters

                ' Sets obtained user values as current parameters' values.
                dashboardViewer1.BeginUpdateParameters()
                For i As Integer = 0 To parameters1.Count - 1
                    parameters1(i).Value = values(i)
                Next i
                dashboardViewer1.EndUpdateParameters()
            End If
        End Sub
    End Class
End Namespace

Inheritance

Object

DashboardParameterDescriptor