ASPxClientDashboardParameter Class

A client-side dashboard parameter.

Namespace: DevExpress.DashboardWeb.Scripts

Assembly: DevExpress.Dashboard.v18.2.Web.WebForms.Scripts.dll

Declaration

C#
VB.NET

public class ASPxClientDashboardParameter

Public Class ASPxClientDashboardParameter

The following members return ASPxClientDashboardParameter objects:

Remarks

The ASPxClientDashboardParameter class exposes the ASPxClientDashboardParameter.Name and ASPxClientDashboardParameter.Value properties. These allow you to obtain the dashboard parameter name and specify its value on the client side.

Example

This example demonstrates how to change dashboard parameter values in the ASPxDashboard control on the client side using the ASPxClientDashboard.GetParameters method.

In this example, parameter values are specified using the ASPxClientDashboardParameter.SetValue method. The ASPxClientDashboard.ShowParametersDialog method is used to invoke the Dashboard Parameters dialog that displays applied parameter values.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/aspxdashboard-how-to-specify-dashboard-parameter-values-on-the-client-side-t495684.

<%@ Page Language="C#" AutoEventWireup="true" CodeBehind="Default.aspx.cs" 
    Inherits="ASPxDashboard_SetParameterValues.Default" %>

<%@ Register Assembly="DevExpress.Dashboard.v17.1.Web, Version=17.1.2.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a" 
    Namespace="DevExpress.DashboardWeb" TagPrefix="dx" %>

<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
    <title></title>
</head>
<body>
    <form id="form1" runat="server">
    <div id="setParameterValuesButton" style="float: left; margin-left: 150px;"></div>
    <div id="showParametersForm" style="float: left; margin-left: 100px;"></div>

    <div style="position: absolute; left: 0; right: 0; top:50px; bottom:0;">
        <dx:ASPxDashboard ID="ASPxDashboard1" runat="server" 
            WorkingMode="Viewer" 
            ClientInstanceName="webViewer"
            ClientSideEvents-DashboardEndUpdate="function() { setParameterValues(); }"
            Width="100%" Height="100%">
        </dx:ASPxDashboard>
    </div>
    </form>
</body>
</html>
<script type="text/javascript" src="<%= Page.ResolveClientUrl("~/Scripts/ParameterValues.js") %>"></script>

using System;

namespace ASPxDashboard_SetParameterValues
{
    public partial class Default : System.Web.UI.Page
    {
        protected void Page_Load(object sender, EventArgs e)
        {
            ASPxDashboard1.DashboardXmlPath = Server.MapPath("App_Data/dashboard1.xml");
        }
    }
}

function setParameterValues() {
    $("#setParameterValuesButton").dxButton({
        text: 'Specify parameter values',
        onClick: function () {
            var parameters = webViewer.GetParameters();
            var parameter1 = parameters.GetParameterByName("categoryParameter"),
                parameter2 = parameters.GetParameterByName("startDateParameter");
            parameter1.SetValue("Condiments");
            parameter2.SetValue(new Date(2015, 3, 1));            
        }
    });

    $("#showParametersForm").dxButton({
        text: 'Show Parameters Form',
        onClick: function () {
            webViewer.ShowParametersDialog();
        }
    });
};

Imports System

Namespace ASPxDashboard_SetParameterValues
    Partial Public Class [Default]
        Inherits System.Web.UI.Page

        Protected Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
            ASPxDashboard1.DashboardXmlPath = Server.MapPath("App_Data/dashboard1.xml")
        End Sub
    End Class
End Namespace

function setParameterValues() {
    $("#setParameterValuesButton").dxButton({
        text: 'Specify parameter values',
        onClick: function () {
            var parameters = webViewer.GetParameters();
            var parameter1 = parameters.GetParameterByName("categoryParameter"),
                parameter2 = parameters.GetParameterByName("startDateParameter");
            parameter1.SetValue("Condiments");
            parameter2.SetValue(new Date(2015, 3, 1));            
        }
    });

    $("#showParametersForm").dxButton({
        text: 'Show Parameters Form',
        onClick: function () {
            webViewer.ShowParametersDialog();
        }
    });
};

<%@ Page Language="vb" AutoEventWireup="true" CodeBehind="Default.aspx.vb" 
    Inherits="ASPxDashboard_SetParameterValues.Default" %>

<%@ Register Assembly="DevExpress.Dashboard.v17.1.Web, Version=17.1.2.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a" 
    Namespace="DevExpress.DashboardWeb" TagPrefix="dx" %>

<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
    <title></title>
</head>
<body>
    <form id="form1" runat="server">
    <div id="setParameterValuesButton" style="float: left; margin-left: 150px;"></div>
    <div id="showParametersForm" style="float: left; margin-left: 100px;"></div>

    <div style="position: absolute; left: 0; right: 0; top:50px; bottom:0;">
        <dx:ASPxDashboard ID="ASPxDashboard1" runat="server" 
            WorkingMode="Viewer" 
            ClientInstanceName="webViewer"
            ClientSideEvents-DashboardEndUpdate="function() { setParameterValues(); }"
            Width="100%" Height="100%">
        </dx:ASPxDashboard>
    </div>
    </form>
</body>
</html>
<script type="text/javascript" src="<%=Page.ResolveClientUrl("~/Scripts/ParameterValues.js")%>"></script>

Inheritance

Object

ASPxClientDashboardParameter

Controls

Tools

Controls and Extensions

Tools

Maintenance Mode

Controls

Tools

Controls and Extensions

Tools

Maintenance Mode

ASPxClientDashboardParameter Class

Declaration

Remarks

Example

Inheritance

ASPxClientDashboardParameter Class

Declaration

Related API Members

Remarks

Example

Inheritance