TdxBackendCustomParameter Class

The base class for parameters used in TdxDashboard/TdxDashboardControl and TdxReport components.

Declaration

delphi

TdxBackendCustomParameter = class abstract(TCollectionItem)

Remarks

Parameters allow you to apply dynamic filters to source data for TdxDashboard/TdxDashboardControl and TdxReport components.

Main API Members

The list below outlines key members of the TdxBackendCustomParameter class. These members allow you to configure data field parameters in backend client components.

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.

Indirect TdxBackendCustomParameter References

The following public API members reference the TdxBackendCustomParameter class as terminal descendant instances:

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

Terminal TdxBackendCustomParameter Class Descendants

Do not use the TdxBackendCustomParameter class directly. Use the following descendants instead:

TdxDashboardParameterA dashboard parameter.TdxReportParameterA report parameter collection.

Inheritance

TObject TPersistent TCollectionItem TdxBackendCustomParameter