Parameter.ValueSourceSettings Property

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

Namespace: DevExpress.XtraReports.Parameters

Assembly: DevExpress.Printing.v24.1.Core.dll

NuGet Package: DevExpress.Printing.Core

Declaration

C#

[TypeConverter("DevExpress.XtraReports.Design.ParameterValueSourceSettingsConverter,DevExpress.Utils.v24.1.UI, Version=24.1.99.0, Culture=neutral, PublicKeyToken=c38a27d2243c2672")]
[XtraSerializableProperty(XtraSerializationVisibility.Reference)]
public virtual ValueSourceSettings ValueSourceSettings { get; set; }

VB.NET

<XtraSerializableProperty(XtraSerializationVisibility.Reference)>
<TypeConverter("DevExpress.XtraReports.Design.ParameterValueSourceSettingsConverter,DevExpress.Utils.v24.1.UI, Version=24.1.99.0, Culture=neutral, PublicKeyToken=c38a27d2243c2672")>
Public Overridable Property ValueSourceSettings As ValueSourceSettings

Property Value

Type	Description
ValueSourceSettings	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

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ValueSourceSettings 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#L25

});
customMailParameterLookup.ValueSourceSettings = staticListLookUpSettings1;
//

reporting-winforms-parameter-daterange/CS/Program.cs#L41

// Assign the settings to the parameter's ValueSourceSettings property.
dateRangeParam.ValueSourceSettings = dateRangeSettings;

VB.NET

reporting-winforms-parameter-daterange/VB/Program.vb#L33

' Assign the settings to the parameter's ValueSourceSettings property.
dateRangeParam.ValueSourceSettings = dateRangeSettings

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

' Assign the specified settings to the parameter's ValueSourceSettings property.
dateParameter.ValueSourceSettings = lookupSettings