Back to Devexpress

TdxDashboard.Parameters Property

vcl-dxdashboard-dot-tdxdashboard-d315742c.md

latest2.4 KB
Original Source

TdxDashboard.Parameters Property

Provides access to the collection of dashboard parameters.

Declaration

delphi
property Parameters: TdxDashboardParameters read;

Property Value

TypeDescription
TdxDashboardParameters

A dashboard parameter collection.

|

Remarks

The collection accessible through the Parameters property is populated automatically from the current dashboard layout definition.

Note

The Parameters property provides access to a read-only dashboard parameters 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.

Available Options

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.

BeginUpdate/EndUpdate and Batch Parameter Changes

Every time you modify a parameter stored within the Parameters collection, the State property value is updated. Enclose multiple parameter changes between Parameters.BeginUpdate and Parameters.EndUpdate procedure calls to avoid excessive state updates and improve performance.

See Also

TdxDashboard.Layout Property

TdxDashboard.State Property

TdxDashboard Class

TdxDashboard Members

dxDashboard Unit