Back to Devexpress

RangeStartParameter Class

corelibraries-devexpress-dot-xtrareports-dot-parameters-6e69bd7f.md

latest6.0 KB
Original Source

RangeStartParameter Class

A range parameter‘s nested start parameter in a report.

Namespace : DevExpress.XtraReports.Parameters

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

NuGet Package : DevExpress.Printing.Core

Declaration

csharp
public class RangeStartParameter :
    RangeBoundaryParameter
vb
Public Class RangeStartParameter
    Inherits RangeBoundaryParameter

The following members return RangeStartParameter objects:

Remarks

RangeStartParameter is a date range parameter‘s nested parameter that specifies the range’s start date.

An instance of RangeStartParameter is created when you instantiate the RangeParametersSettings class. Use the RangeParameterSettings.StartParameter property to access the RangeStartParameter instance.

Specify the following properties to configure a date range parameter’s nested start parameter:

  • Name - the parameter’s name that you can use to refer to the parameter.
  • Value - the parameter’s value.
  • ExpressionBindings - the parameter’s expression bindings collection.

Example

The code sample below uses a RangeParametersSettings class instance to create a date range parameter, set the range value to the last 7 days, and filter report data by this range.

csharp
using DevExpress.XtraReports.Parameters;
using DevExpress.XtraReports.Expressions;
// ...
XtraReport1 report = new XtraReport1();
// Create a date range parameter.
Parameter myDateRange = new Parameter();
myDateRange.Name = "myDateRange";
myDateRange.Description = "Date Range:";
// Set the Visible property to true to request the parameter value from users.
// Set this property to false to silently apply the parameter's value.
myDateRange.Visible = false;
myDateRange.Type = typeof(System.DateTime);
RangeParametersSettings myDateRangeSettings = new RangeParametersSettings();
myDateRangeSettings.StartParameter.Name = "MyDateRangeStart";
// Set the range parameter's start date to 7 days ago.
myDateRangeSettings.StartParameter.ExpressionBindings.Add(new BasicExpressionBinding("Value", "AddDays(Today(), -7)"));
myDateRangeSettings.EndParameter.Name = "MyDateRangeEnd";
// Set the range parameter's end date to today.
myDateRangeSettings.EndParameter.ExpressionBindings.Add(new BasicExpressionBinding("Value", "Today()"));
myDateRange.ValueSourceSettings = myDateRangeSettings;
report.Parameters.Add(myDateRange);
// Filter report data by the specified start and end dates.
report.FilterString = "GetDate([OrderDate]) Between(?MyDateRangeStart,?MyDateRangeEnd)";
vb
Imports DevExpress.XtraReports.Parameters
Imports DevExpress.XtraReports.Expressions
' ...
Dim report As New XtraReport1()
' Create a date range parameter.
Dim myDateRange As New Parameter()
myDateRange.Name = "myDateRange"
myDateRange.Description = "Date Range:"
' Set the Visible property to true to request the parameter value from users.
' Set this property to false to silently apply the parameter's value.
myDateRange.Visible = False
myDateRange.Type = GetType(Date)
Dim myDateRangeSettings As New RangeParametersSettings()
myDateRangeSettings.StartParameter.Name = "MyDateRangeStart"
' Set the range parameter's start date to 7 days ago.
myDateRangeSettings.StartParameter.ExpressionBindings.Add(New BasicExpressionBinding("Value", "AddDays(Today(), -7)"))
myDateRangeSettings.EndParameter.Name = "MyDateRangeEnd"
' Set the range parameter's end date to today.
myDateRangeSettings.EndParameter.ExpressionBindings.Add(New BasicExpressionBinding("Value", "Today()"))
myDateRange.ValueSourceSettings = myDateRangeSettings
report.Parameters.Add(myDateRange)
' Filter report data by the specified start and end dates.
report.FilterString = "GetDate([OrderDate]) Between(?MyDateRangeStart,?MyDateRangeEnd)"

Implements

IXtraSupportDeserializeCollectionItem

IParameter

IFilterParameter

Inheritance

Object MarshalByRefObject Component Parameter RangeBoundaryParameter RangeStartParameter

See Also

RangeStartParameter Members

Range Report Parameters

DevExpress.XtraReports.Parameters Namespace