DashboardViewer.Parameters Property

Provides access to dashboard parameter settings and metadata.

Namespace: DevExpress.DashboardWin

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

NuGet Package: DevExpress.Win.Dashboard

Declaration

C#

[Browsable(false)]
public DashboardParameters Parameters { get; }

VB.NET

<Browsable(False)>
Public ReadOnly Property Parameters As DashboardParameters

Property Value

Type	Description
DashboardParameters	A DashboardParameters object representing a collection of DashboardParameterDescriptor objects.

Remarks

DashboardParameterDescriptor class objects returned by the Parameters property 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 property), etc.

The DashboardParameterDescriptor.Values property returns possible parameter values. Use the DashboardParameterDescriptor.Value property to obtain or specify the current parameter value.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Parameters 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#

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

IList<DashboardParameterDescriptor> parameters = dashboardViewer1.Parameters;

VB.NET

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

Dim parameters As IList(Of DashboardParameterDescriptor) = dashboardViewer1.Parameters

Implements

Parameters