LookUpHelper.GetLookUpValues(ValueSourceSettings, DataContextBase, IParameterEditorValueProvider) Method

Returns a collection of parameter look-up values.

Namespace: DevExpress.XtraReports.Parameters

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

NuGet Package: DevExpress.Printing.Core

Declaration

C#

public static LookUpValueCollection GetLookUpValues(
    ValueSourceSettings valueSourceSettings,
    DataContextBase dataContext,
    IParameterEditorValueProvider parameterValueProvider = null
)

VB.NET

Public Shared Function GetLookUpValues(
    valueSourceSettings As ValueSourceSettings,
    dataContext As DataContextBase,
    parameterValueProvider As IParameterEditorValueProvider = Nothing
) As LookUpValueCollection

Parameters

Name	Type	Description
valueSourceSettings	ValueSourceSettings	Settings for a source of the parameter look-up values.
dataContext	DevExpress.Data.Browsing.DataContextBase	A DataContext object.

Optional Parameters

Name	Type	Default	Description
parameterValueProvider	IParameterEditorValueProvider	null	An object that implements the IParameterEditorValueProvider interface.

Returns

Type	Description
LookUpValueCollection	A collection of parameter look-up values.

Example

The following code example demonstrates how to use the GetLookUpValues method of the LookUpHelper class to access look-up values of a multi-value report parameter. The example also shows how to display the descriptions of the selected parameter values in the report’s XRLabel control.

C#

using DevExpress.Data.Browsing;
using DevExpress.XtraReports.Parameters;
using System;
// ...
private void XtraReport1_BeforePrint(object sender, System.ComponentModel.CancelEventArgs e) {
    var valueSourceSettings = this.Parameters["param1"].ValueSourceSettings;
    var dataContext = (sender as IServiceProvider).GetService(typeof(DataContext)) as DataContext;

    var lookupValues = LookUpHelper.GetLookUpValues(valueSourceSettings, dataContext);
    var selectedValues = this.Parameters["param1"].Value as Int32[];

    var text = "";

    int step = 0;
    for (var j = 0; j < lookupValues.Count; j++) {
        if (Array.IndexOf(selectedValues, Convert.ToInt32(lookupValues[j].Value)) > -1) {
            step += 1;
            if (step == selectedValues.Length) {
                text += lookupValues[j].Description;
            } else {
                text += lookupValues[j].Description + ", ";
            }
        }
    }

    xrLabel1.Text = text;
}

VB.NET

Imports DevExpress.Data.Browsing
Imports DevExpress.XtraReports.Parameters
Imports System
' ...
Private Sub XtraReport1_BeforePrint(ByVal sender As Object, ByVal e As System.ComponentModel.CancelEventArgs) Handles Me.BeforePrint
    Dim valueSourceSettings = Me.Parameters("param1").ValueSourceSettings
    Dim dataContext = TryCast((TryCast(sender, IServiceProvider)).GetService(GetType(DataContext)), DataContext)

    Dim lookupValues = LookUpHelper.GetLookUpValues(valueSourceSettings, dataContext)
    Dim selectedValues = TryCast(Me.Parameters("param1").Value, Int32())
    Dim text_Renamed = ""

    Dim [step] As Integer = 0
    For j = 0 To lookupValues.Count - 1
        If Array.IndexOf(selectedValues, Convert.ToInt32(lookupValues(j).Value)) > -1 Then
            [step] += 1
            If [step] = selectedValues.Length Then
                text_Renamed &= lookupValues(j).Description
            Else
                text_Renamed &= lookupValues(j).Description & ", "
            End If
        End If
    Next j

    xrLabel1.Text = text_Renamed
End Sub