TdxDashboardParameters Class
A collection of dashboard parameters.
Declaration
TdxDashboardParameters = class(
TdxBackendCustomParameters<TdxDashboardParameter>
)Remarks
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 initially empty. Call the LoadFromLayout procedure to populate the collection from the current dashboard layout definition. Subsequent LoadFromLayout calls update the collection.
Main API Members
The list below outlines key members of the TdxDashboardParameters class. These members allow you to access and modify parameters in a dashboard.
- BeginUpdate | EndUpdate
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.
- Count
- Returns the number of parameters stored in the collection.
- FindParam | ParamByName
- Return a stored parameter by its name.
- Items
- Provides indexed access to parameters in the collection.
- LoadFromLayout
- Populates/updates the collection from the current dashboard layout definition.
Code Examples
Related GitHub-Hosted Example Projects
Direct TdxDashboardParameters Class Reference
The TdxCustomDashboardControl.Parameters property references a TdxDashboardParameters object.