The requested page is not available for the requested platform. You are viewing the content for Default platform.
All docs
V19.1
19.2 (EAP/Beta)
19.1
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

ASPxClientDashboardParameters Class

A collection of ASPxClientDashboardParameter objects.

Declaration

declare class ASPxClientDashboardParameters

Remarks

The ASPxClientDashboardParameter object contains parameter settings and metadata.

Use the ASPxClientDashboard.GetParameters method to change parameter values.

Methods

GetParameterByIndex(index) Method

Returns a dashboard parameter by its index in the ASPxClientDashboardParameters collection.

Declaration

GetParameterByIndex(index: number): ASPxClientDashboardParameter

Parameters

Name Type Description
index number

An integer value that specifies the parameter index.

Returns

Type Description
ASPxClientDashboardParameter

A ASPxClientDashboardParameter object that is the client-side dashboard parameter.

See Also

GetParameterByName(name) Method

Returns a dashboard parameter by its name.

Declaration

GetParameterByName(name: string): ASPxClientDashboardParameter

Parameters

Name Type Description
name string

A String object that specifies the parameter name.

Returns

Type Description
ASPxClientDashboardParameter

A ASPxClientDashboardParameter object that is the client-side dashboard parameter.

See Also

GetParameterList Method

Returns an array of dashboard parameters from the ASPxClientDashboardParameters collection.

Declaration

GetParameterList(): ASPxClientDashboardParameter[]

Returns

Type Description
ASPxClientDashboardParameter[]

An array of ASPxClientDashboardParameter objects representing client-side dashboard parameters.