TdxDashboardParameter Class

Declaration

delphi

TdxDashboardParameter = class(
    TdxBackendCustomParameter
)

Remarks

A dashboard parameter is a dynamic value that can replace constants in expressions, calculated fields, etc.

Main API Members

The list below outlines key members of the TdxDashboardParameter class. These members allow you to configure dashboard parameters.

AllowNullSpecifies if an empty field is interpreted as a Null or empty string value.DataTypeReturns the parameter data type.DescriptionReturns the parameter’s description defined in the UI.Enabled | VisibleSpecify if the parameter editor is visible and enabled in the UI.IsMultiValueParameterIdentifies if the parameter uses multiple values accessible through the Values property.NameReturns the parameter’s unique name defined in the UI.Value | ValuesProvide access to parameter values.

Code Examples

Related GitHub-Hosted Example Projects

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

Direct TdxDashboardParameter Class References

The following public API members reference a TdxDashboardParameter object:

TdxDashboardParameters.FindParamReturns the stored parameter with the specified name.TdxDashboardParameters.ItemsProvides indexed access to all parameters stored in the collection.TdxDashboardParameters.ParamByNameReturns the stored parameter with the specified name.

Inheritance

TObject TPersistent TCollectionItem TdxBackendCustomParameter TdxDashboardParameter