TdxBackendCustomParameter.Enabled Property

Specifies if the parameter’s editor is enabled in the Report or Dashboard UI.

Declaration

property Enabled: Boolean read; write; default True;

Property Value

Type	Default	Description
Boolean	True	True if the parameter’s editor is enabled in the end-user UI; otherwise, False.

Remarks

Use the Enabled property to specify if users can change the parameter value in the UI.

This property corresponds to the Enabled combo box in report settings:

Code Example: Disable a Parameter’s Editor

The following code snippet disables the ShowPendingTransactions parameter for closed periods so users cannot change its value in the UI:

Delphi

uses
  dxReport,              // Declares the TdxReport class
  dxReport.Parameters,   // Declares the TdxReportParameter class
  System.SysUtils;       // Declares the CurrentYear function

procedure TForm1.ShowTransactionsReport(ATransactionsYear: Integer);
var
  AShowPendingTransactionsParameter : TdxReportParameter;
begin
  // Set the reporting period
  dxReport1.Parameters['TransactionsYear'].Value := ATransactionsYear;
  // Access the `ShowPendingTransactions` report parameter
  AShowPendingTransactionsParameter := dxReport1.Parameters['ShowPendingTransactions'];
  if ATransactionsYear < CurrentYear then
  begin
    // Indicate that the period is closed
    AShowPendingTransactionsParameter.Value := False;
    // Prevent users from changing the parameter value in the UI
    AShowPendingTransactionsParameter.Enabled := False;
  end;
  // Open the report
  dxReport1.ShowViewer;
end;

C++

#include "dxReport.hpp"              // Declares the TdxReport class
#include "dxReport.Parameters.hpp"   // Declares the TdxReportParameter class
#include <System.SysUtils.hpp>       // Declares the CurrentYear function

// Add the following linker directives to the corresponding CPP source file:
#pragma link "dxReport"   // Required to use dxReport.hpp declarations

void __fastcall TForm1::ShowTransactionsReport(int ATransactionsYear)
{
  // Set the reporting period
  dxReport1->Parameters[L"TransactionsYear"]->Value = ATransactionsYear;
  // Access the `ShowPendingTransactions` report parameter
  TdxReportParameter *AShowPendingTransactionsParameter =
    dxReport1->Parameters[L"ShowPendingTransactions"];
  if (ATransactionsYear < CurrentYear())
  {
    // Indicate that the period is closed
    AShowPendingTransactionsParameter->Value = false;
    // Prevent users from changing the parameter value in the UI
    AShowPendingTransactionsParameter->Enabled = false;
  }
  // Open the report
  dxReport1->ShowViewer();
}