Parameter Class

Provides functionality to a report parameter.

Namespace: DevExpress.Snap.Core.API

Assembly: DevExpress.Snap.v18.1.Core.dll

Declaration

C#

[TypeConverter("DevExpress.XtraReports.Design.ParameterValueEditorChangingConverter,DevExpress.Utils.v18.1.UI")]
public class Parameter :
    IParameter,
    IFilterParameter,
    INotifyPropertyChanged

VB.NET

<TypeConverter("DevExpress.XtraReports.Design.ParameterValueEditorChangingConverter,DevExpress.Utils.v18.1.UI")>
Public Class Parameter
    Implements IParameter,
               IFilterParameter,
               INotifyPropertyChanged

Related API Members

The following members accept/return Parameter objects:

• Parameter.Clone()
• ParameterCollection.Item[String]

Remarks

To create a parameter, specify its Parameter.Type and Parameter.Value.

The value type can be set to one of the Type enumeration values, each corresponding to a specific .NET type (e.g. String, Boolean, Int32).

Make sure to assign a value of the appropriate type to the parameter. If the value is left empty at design time, you either need to provide this value in code, or your end-users will be prompted to enter and submit parameter values in Print Preview.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Parameter class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

snap-report-api-examples-t429162/CS/SnapServerExamples/CodeExamples/DataVisualizationToolsActions.cs#L23

//Create parameter:
Parameter param1 = new Parameter();
param1.Name = "Region";

VB.NET

snap-report-api-examples-t429162/VB/SnapServerExamples/CodeExamples/DataVisualizationToolsActions.vb#L20

'Create parameter:
Dim param1 As New Parameter()
param1.Name = "Region"

Inheritance

Object

Parameter