TdxBackendCustomParameters<T>.FindParam(string) Method

Returns the stored parameter with the specified name.

Declaration

function FindParam(const AName: string): T;

Parameters

Name	Type	Description
AName	string	The name of the target parameter stored within the collection.

Returns

Type	Description
T	The parameter with the name matching the AName parameter value. The function returns nil (in Delphi) or nullptr (in C++Builder) if the collection contains no parameter with the name that matches the AName parameter value.

Remarks

Call the FindParam function to safely access a stored parameter with the specified name.

Code Examples

Note

The FindParam method is common to report and dashboard parameters. These examples perform the same operation but use component-specific APIs.

Find Report Parameter by Name

Delphi

uses
  dxReport.Control,      // Declares the TdxReportControl class
  dxReport.Parameters,   // Declares the TdxReportParameter class
  dxMessageDialog;       // Declares the TdxMessageDialogForm class

procedure TForm1.cxButton1Click(Sender: TObject);
var
  AParameter: TdxReportParameter;
begin
  // Find a parameter with the specified name
  AParameter := dxReportControl1.Parameters.FindParam('countryParameter');
  if AParameter <> nil then
    // Display the parameter label
    dxShowMessage(AParameter.Description)
  else
    dxShowMessage('Parameter not found.');
end;

C++

#include "dxReport.Control.hpp"      // Declares the TdxReportControl class
#include "dxReport.Parameters.hpp"   // Declares the TdxReportParameter class
#include "dxMessageDialog.hpp"       // Declares the TdxMessageDialogForm class

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

void __fastcall TForm1::cxButton1Click(TObject* Sender) {
  // Find a parameter with the specified name
  TdxReportParameter* AParameter = dxReportControl1->Parameters->FindParam(L"countryParameter");
  if (AParameter != nullptr)
    // Display the parameter label
    dxShowMessage(AParameter->Description);
  else
    dxShowMessage(L"Parameter not found.");
}

Find Dashboard Parameter by Name

Delphi

uses
  dxDashboard.Control,      // Declares the TdxDashboardControl class
  dxDashboard.Parameters,   // Declares the TdxDashboardParameter class
  dxMessageDialog;          // Declares the TdxMessageDialogForm class

procedure TForm1.cxButton1Click(Sender: TObject);
var
  AParameter: TdxDashboardParameter;
begin
  // Find a parameter with the specified name
  AParameter := dxDashboardControl1.Parameters.FindParam('countryParameter');
  if AParameter <> nil then
    // Display the parameter label
    dxShowMessage(AParameter.Description)
  else
    dxShowMessage('Parameter not found.');
end;

C++

#include "dxDashboard.Control.hpp"      // Declares the TdxDashboardControl class
#include "dxDashboard.Parameters.hpp"   // Declares the TdxDashboardParameter class
#include "dxMessageDialog.hpp"          // Declares the TdxMessageDialogForm class

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

void __fastcall TForm1::cxButton1Click(TObject* Sender) {
  // Find a parameter with the specified name
  TdxDashboardParameter* AParameter = dxDashboardControl1->Parameters->FindParam(L"countryParameter");
  if (AParameter != nullptr)
    // Display the parameter label
    dxShowMessage(AParameter->Description);
  else
    dxShowMessage(L"Parameter not found.");
}