Parameter.MultiValue Property

Specifies whether you and end users can pass multiple values to a report parameter.

Namespace: DevExpress.XtraReports.Parameters

Assembly: DevExpress.Printing.v23.2.Core.dll

NuGet Package: DevExpress.Printing.Core

Declaration

C#

[DefaultValue(false)]
public virtual bool MultiValue { get; set; }

VB.NET

<DefaultValue(False)>
Public Overridable Property MultiValue As Boolean

Property Value

Type	Default	Description
Boolean	false	true to make a parameter multivalue; otherwise, false.

Example

The code sample below demonstrates how to do the following:

1. Create a multi-value report parameter.
2. Configure a DynamicListLookUpSettings class instance to load predefined values for this parameter from a database.
3. Select all predefined parameter values as defaults.

C#

using DevExpress.XtraReports.Parameters;
// ...
// Create a parameter and set up its properties. Set the
// parameter's MultiValue property to true to make it multi-value.
var parameter1 = new Parameter() {
    Name = "categories",
    Description = "Categories: ",
    Type = typeof(System.Int32),
    MultiValue = true
};

// Create a DynamicListLookUpSettings class instance and
// configure its properties to retrieve the parameter's predefined values
// from the report's data source.
var lookupSettings = new DynamicListLookUpSettings() {
    DataSource = report.DataSource,
    DataMember = "Categories",
    DisplayMember = "CategoryName",
    ValueMember = "CategoryId"
};

// Assign the setting to the parameter's LookUpSettings property.
parameter1.LookUpSettings = lookupSettings;

// Enable the parameter's SelectAllValues property to use
// all predefined values as defaults.
parameter1.SelectAllValues = true;

VB

Imports DevExpress.XtraReports.Parameters
' ...
' Create a parameter and set up its properties. Set the
' parameter's MultiValue property to true to make it multi-value.
Dim parameter1 = New Parameter() With {
    .Name = "categories",
    .Description = "Categories: ",
    .Type = GetType(System.Int32),
    .MultiValue = True
}

' Create a DynamicListLookUpSettings class instance and
' configure its properties to retrieve the parameter's predefined values
' from the report's data source.
Dim lookupSettings = New DynamicListLookUpSettings() With {
    .DataSource = report.DataSource,
    .DataMember = "Categories",
    .DisplayMember = "CategoryName",
    .ValueMember = "CategoryId"
}

' Assign the setting to the parameter's LookUpSettings property.
parameter1.LookUpSettings = lookupSettings

' Enable the parameter's SelectAllValues property to use
' all predefined values as defaults.
parameter1.SelectAllValues = True

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the MultiValue property.

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#

reporting-mvc-custom-parameter-editor/CS/CustomReportParameterType/Reports/XtraReport1.cs#L37

customMailParameterMultivalue.Description = "Multi-value Email Parameter";
customMailParameterMultivalue.MultiValue = true;
customMailParameterMultivalue.Name = "customMailParameterMultivalue";

reporting-winforms-parameter-dynamic-list/CS/MultiValueParametersExample/Form1.cs#L23

param1.Type = typeof(System.Int32);
param1.MultiValue = true;
param1.Description = "Categories: ";

reporting-winforms-parameter-static-list/CS/ParameterLookUpWindowsFormsApplication/Form1.cs#L19

Parameter parameter1 = new Parameter();
parameter1.MultiValue = true;
parameter1.Name = "parameterCategory";

reporting-winforms-parameter-multivalue/CS/Program.cs#L29

parameter1.Type = typeof(System.Int32);
parameter1.MultiValue = true;
parameter1.Description = "Categories: ";

VB.NET

reporting-winforms-parameter-dynamic-list/VB/MultiValueParametersExample/Form1.vb#L24

param1.Type = GetType(Integer)
param1.MultiValue = True
param1.Description = "Categories: "

reporting-winforms-parameter-static-list/VB/ParameterLookUpWindowsFormsApplication/Form1.vb#L21

Dim parameter1 As Parameter = New Parameter()
parameter1.MultiValue = True
parameter1.Name = "parameterCategory"