Back to Devexpress

Parameter.MultiValue Property

corelibraries-devexpress-dot-xtrareports-dot-parameters-dot-parameter.md

latest4.6 KB
Original Source

Parameter.MultiValue Property

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

Namespace : DevExpress.XtraReports.Parameters

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

NuGet Package : DevExpress.Printing.Core

Declaration

csharp
[DefaultValue(false)]
public virtual bool MultiValue { get; set; }
vb
<DefaultValue(False)>
Public Overridable Property MultiValue As Boolean

Property Value

TypeDefaultDescription
Booleanfalse

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.

csharp
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

The following code snippet (auto-collected from DevExpress Examples) contains a reference 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.

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

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

See Also

Multi-Value Report Parameters

Parameter Class

Parameter Members

DevExpress.XtraReports.Parameters Namespace