To add a parameter field to a report

Report Application Server .NET SDK Developer Guide

To add a parameter field to a report

Visual Basic

Dim parameterField As New ParameterField()

C#

ParameterField parameterField = new ParameterField();

Visual Basic

parameterField.Description = "New string parameter"

C#

parameterField.Description = "New string parameter";

Note

Not all types may be used for parameter fields. For example, you may not set Type to 20 (Bitmap). Use the isValidType method in the ParameterFieldController class to determine if a certain type is valid for a parameter field.

Visual Basic

parameterField.ParameterType = CrParameterFieldTypeEnum.crParameterFieldTypeReportParameter
parameterField.ValueRangeKind = CrParameterValueRangeKindEnum.crParameterValueRangeKindDiscrete
parameterField.Type = CrFieldValueTypeEnum.crFieldValueTypeStringField

C#

parameterField.ParameterType = CrParameterFieldTypeEnum.crParameterFieldTypeReportParameter;
parameterField.ValueRangeKind = CrParameterValueRangeKindEnum.crParameterValueRangeKindDiscrete;
parameterField.Type = CrFieldValueTypeEnum.crFieldValueTypeStringField;

Visual Basic

parameterField.Name = "NewParameter"
parameterField.CurrentValues.Add("New Parameter")

C#

parameterField.Name = "NewParameter";
parameterField.CurrentValues.Add("New Parameter");

Note

When a parameter is added using the ParameterFieldController class, it is not placed on the report, and the user will not be prompted when the report is refreshed. To use the parameter field to prompt a user, the parameter must be used in a filter, or must be added using the ResultFieldController class.

Visual Basic

rcd.DataDefController.ParameterFieldController.Add(parameterField)

C#

rcd.DataDefController.ParameterFieldController.Add(parameterField);

Visual Basic

Private Sub AddParameterToReport(ByVal rcd As ISCDReportClientDocument)
 Dim parameterField As New ParameterField()
 parameterField.Description = "New string parameter"
 parameterField.ParameterType = CrParameterFieldTypeEnum.crParameterFieldTypeReportParameter
 parameterField.ValueRangeKind = CrParameterValueRangeKindEnum.crParameterValueRangeKindDiscrete
 parameterField.Type = CrFieldValueTypeEnum.crFieldValueTypeStringField
 parameterField.Name = "NewParameter"
 parameterField.CurrentValues.Add("New Parameter")
 rcd.DataDefController.ParameterFieldController.Add(parameterField)
End Sub

C#

private void AddParameterToReport(ISCDReportClientDocument rcd)
{
 ParameterField parameterField = new ParameterField();
 parameterField.Description = "New string parameter";
 parameterField.ParameterType = CrParameterFieldTypeEnum.crParameterFieldTypeReportParameter;
 parameterField.ValueRangeKind = CrParameterValueRangeKindEnum.crParameterValueRangeKindDiscrete;
 parameterField.Type = CrFieldValueTypeEnum.crFieldValueTypeStringField;
 parameterField.Name = "NewParameter";
 parameterField.CurrentValues.Add("New Parameter");
 rcd.DataDefController.ParameterFieldController.Add(parameterField);
}