TdxBackendCustomParameter.Name Property

Returns the unique Report or Dashboard parameter name (identifier).

Declaration

property Name: string read;

Property Value

Type	Description
string	The unique identifier.

Remarks

Use the Name property to read the unique parameter identifier.

This property corresponds to the Name field in report / dashboard settings:

Report

Dashboard

Note

If the Description property is unspecified, the Name property value is used as the parameter label.

Code Examples

The following code snippets display all parameter labels or names (unique identifiers) for parameters with missing labels.

Note

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

List Report Parameter Names

Delphi

uses
  dxReport.Control,      // Declares the TdxReportControl class
  dxReport.Parameters,   // Declares the TdxReportParameter class
  dxMessageDialog,       // Declares the TdxMessageDialogForm class
  System.StrUtils;       // Provides advanced string management routines

procedure TForm1.cxButton1Click(Sender: TObject);
var
  AList: TStringList;
  AParameter: TdxReportParameter;
begin
  // Create a TStringList instance
  AList := TStringList.Create;
  try
    // Iterate through report parameters
    for AParameter in dxReportControl1.Parameters do
      AList.Add(Format('- %s', [
        // Use the parameter Name if Description is missing
        IfThen(AParameter.Description <> '', AParameter.Description, AParameter.Name)
      ]));
    // Display the parameter list or a notification message if the list is empty
    if AList.Count > 0 then
      dxShowMessage(AList.Text)
    else
      dxShowMessage('The report has no parameters.');
  finally
    AList.Free;
  end;
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) {
  TStringList* AList = new TStringList();
  try {
    // Iterate through report parameters
    for (int i = 0; i < dxReportControl1->Parameters->Count; i++) {
      TdxReportParameter* AParameter = dxReportControl1->Parameters->Items[i];
      UnicodeString ALabel;
      // Use the parameter Name if Description is missing
      if (AParameter->Description.IsEmpty())
        ALabel = AParameter->Name;
      else
        ALabel = AParameter->Description;
      AList->Add(Format(L"- %s", ARRAYOFCONST((ALabel))));
    }
    // Display the parameter list or a notification message if the list is empty
    if (AList->Count > 0)
      dxShowMessage(AList->Text);
    else
      dxShowMessage(L"The report has no parameters.");
  }
  __finally {
    delete AList;
  }
}

List Dashboard Parameter Names

Delphi

uses
  dxDashboard.Control,      // Declares the TdxDashboardControl class
  dxDashboard.Parameters,   // Declares the TdxDashboardParameter class
  dxMessageDialog,          // Declares the TdxMessageDialogForm class
  System.StrUtils;          // Provides advanced string management routines

procedure TForm1.cxButton1Click(Sender: TObject);
var
  AList: TStringList;
  AParameter: TdxDashboardParameter;
begin
  // Create a TStringList instance
  AList := TStringList.Create;
  try
    // Iterate through dashboard parameters
    for AParameter in dxDashboardControl1.Parameters do
      AList.Add(Format('- %s', [
        // Use the parameter Name if Description is missing
        IfThen(AParameter.Description <> '', AParameter.Description, AParameter.Name)
      ]));
    // Display the parameter list or a notification message if the list is empty
    if AList.Count > 0 then
      dxShowMessage(AList.Text)
    else
      dxShowMessage('The dashboard has no parameters.');
  finally
    AList.Free;
  end;
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) {
  TStringList* AList = new TStringList();
  try {
    // Iterate through dashboard parameters
    for (int i = 0; i < dxDashboardControl1->Parameters->Count; i++) {
      TdxDashboardParameter* AParameter = dxDashboardControl1->Parameters->Items[i];
      UnicodeString ALabel;
      // Use the parameter Name if Description is missing
      if (AParameter->Description.IsEmpty())
        ALabel = AParameter->Name;
      else
        ALabel = AParameter->Description;
      AList->Add(Format(L"- %s", ARRAYOFCONST((ALabel))));
    }
    // Display the parameter list or a notification message if the list is empty
    if (AList->Count > 0)
      dxShowMessage(AList->Text);
    else
      dxShowMessage(L"The dashboard has no parameters.");
  }
  __finally {
    delete AList;
  }
}