Skip to main content
You are viewing help content for pre-release software. This document and the features it describes are subject to change.
All docs
V25.2
  • TdxBackendCustomParameter Class

    The base class for backend client parameters.

    Declaration

    TdxBackendCustomParameter = class abstract(TCollectionItem)

    Remarks

    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.

    AllowNull
    Specifies if an empty field is interpreted as a Null or empty string value.
    DataType
    Specifies the parameter data type.
    Description
    Specifies a user-friendly description for the parameter.
    Enabled | Visible
    Specify if the parameter editor is visible and enabled in the UI.
    Name
    Specifies a unique name (identifier) for the parameter.
    ToJSON | FromJSON
    Export/import parameter data to/from a JSON array.
    Values
    Provides access to the collection of parameter values.

    Indirect TdxBackendCustomParameter References

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

    TdxBackendCustomParameters.Add
    Creates a new parameter and adds it to the collection.
    TdxBackendCustomParameters.FindParam
    Returns the stored parameter with the specified name.
    TdxBackendCustomParameters.Items
    Provides indexed access to all parameters stored in the collection.
    TdxBackendCustomParameters.ParamByName
    Returns the stored parameter with the specified name

    Terminal TdxBackendCustomParameter Class Descendants

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

    TdxDashboardParameter
    A dashboard parameter.
    TdxReportParameter
    A report parameter collection.

    Inheritance

    TObject
    TPersistent
    TCollectionItem
    TdxBackendCustomParameter
    See Also