Parameter.ValueSourceSettings Property

Gets or sets settings used to generate predefined values for a report parameter.

Namespace: DevExpress.XtraReports.Parameters

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

NuGet Package: DevExpress.Printing.Core

Declaration

C#

[DefaultValue(null)]
public virtual ValueSourceSettings ValueSourceSettings { get; set; }

VB.NET

<DefaultValue(Nothing)>
Public Overridable Property ValueSourceSettings As ValueSourceSettings

Property Value

Type	Default	Description
ValueSourceSettings	null	Settings used to generate predefined values for a report parameter.

Remarks

Set the ValueSourceSettings property to one of the following class instances:

• StaticListLookUpSettings – stores a static list of predefined parameter values.
• DynamicListLookUpSettings – specifies a data source from which predefined parameter values are retrieved.
• RangeParametersSettings – specifies a date range.

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