Skip to main content
All docs
V25.2
  • TdxCustomDashboardControl.Parameters Property

    Provides access to the collection of dashboard parameters.

    Declaration

    property Parameters: TdxDashboardParameters read; write;

    Property Value

    Type Description
    TdxDashboardParameters

    A dashboard parameter collection.

    Remarks

    The collection accessible through the Parameters property is initially empty. Call the Parameters.LoadFromLayout procedure to populate the collection with dashboard parameters stored within the dashboard layout definition.

    Note

    The Parameters property provides access to a read-only dashboard parameter collection. Subsequent Parameters.LoadFromLayout procedure calls update the Parameters collection.

    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 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.

    Code Examples

    View Example: Pass a Hidden Dashboard Parameter to a SQL Query

    See Also