vcl-dxdashboard-dot-parameters-8a77ff5b.md
A collection of dashboard parameters.
TdxDashboardParameters = class(
TdxBackendCustomParameters<TdxDashboardParameter>
)
Dashboard parameters are dynamic values that can replace constants in expressions, calculated fields, etc. The TdxDashboardParameters class implements a read-only collection of dashboard parameters.
The TdxDashboardParameters collection is populated and updated automatically from the current dashboard layout definition. The list of parameter is read-only, you can only access and modify parameter properties.
The list below outlines key members of the TdxDashboardParameters class. These members allow you to access and modify parameters in a dashboard.
Allow you to avoid excessive notifications and improve performance during batch changes.
Tip
Every individual dashboard parameter change updates the parent dashboard’s State property value. Enclose multiple dashboard parameter changes between BeginUpdate and EndUpdate calls to avoid excessive state updates.
CountReturns the number of parameters stored in the collection.FindParam | ParamByNameReturn a stored parameter by its name.ItemsProvides indexed access to parameters in the collection.
View Example: Pass a Hidden Dashboard Parameter to a SQL Query
The TdxCustomDashboardControl.Parameters property references a TdxDashboardParameters object.
TObject TPersistent TCollection TOwnedCollection TdxBackendCustomParameters<T> TdxDashboardParameters
See Also