TdxDashboardParameter Class
A dashboard parameter.
Declaration
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.
- AllowNull
- Specifies if an empty field is interpreted as a
Nullor empty string value. - DataType
- Returns the parameter data type.
- Description
- Returns the parameter’s description defined in the UI.
- Enabled | Visible
- Specify if the parameter editor is visible and enabled in the UI.
- IsMultiValueParameter
- Identifies if the parameter uses multiple values accessible through the Values property.
- Name
- Returns the parameter’s unique name defined in the UI.
- Value | Values
- Provide access to parameter values.
Direct TdxDashboardParameter Class References
The following public API members reference a TdxDashboardParameter object:
- TdxDashboardParameters.FindParam
- Returns the stored parameter with the specified name.
- TdxDashboardParameters.Items
- Provides indexed access to all parameters stored in the collection.
- TdxDashboardParameters.ParamByName
- Returns the stored parameter with the specified name.
Inheritance
TObject
TPersistent
TCollectionItem
TdxBackendCustomParameter
TdxDashboardParameter
See Also