TdxReportParameter Class

A report parameter.

Declaration

delphi

TdxReportParameter = class(
    TdxBackendCustomParameter
)

Remarks

A report 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 TdxReportParameter class. These members allow you to configure report 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.IsRangeParameterIdentifies if the parameter defines a range of date/time values.NameReturns the parameter’s unique name defined in the UI.Value | ValuesProvide access to parameter values.

Direct TdxReportParameter Class References

The following public API members reference a TdxReportParameter object:

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

Inheritance

TObject TPersistent TCollectionItem TdxBackendCustomParameter TdxReportParameter