vcl-dxdashboard-dot-control-dot-tdxcustomdashboardcontrol-4da6522f.md
Provides access to the collection of dashboard parameters.
property Parameters: TdxDashboardParameters read;
| Type | Description |
|---|---|
| TdxDashboardParameters |
A dashboard parameter collection.
|
The collection accessible through the Parameters property is populated automatically with dashboard parameters stored within dashboard layout definition.
Note
The Parameters property provides access to a read-only dashboard parameter collection. If the list of parameters changes within the dashboard layout definition, the collection is updated automatically the next time you access it in code.
You can use the ParamByName property to access a stored parameter by name. In addition, you can use the Parameters.Items property to access all parameters stored in the collection.
Refer to the TdxDashboardParameters class description for detailed information on all available options.
Every time you modify a parameter stored within the Parameters collection, the State property value is updated and the TdxDashboardControl component redraws content to reflect the change. Enclose multiple parameter changes between Parameters.BeginUpdate and Parameters.EndUpdate procedure calls to avoid UI flickering due to excessive redraw operations and improve performance.
View Example: Pass a Hidden Dashboard Parameter to a SQL Query
See Also
TdxCustomDashboardControl.State Property
TdxDashboard.Parameters Property
TdxCustomDashboardControl Class