Skip to main content

TcxCustomGridDateRange Type

A generic date range for date/time item values.

Declaration

TcxCustomGridDateRange = dxDateRanges.TdxCustomDateRange;

Referenced Class

Type
TdxCustomDateRange

Remarks

You are able to filter and group data in a View by date/time item values combined into the following time periods:

  • Relative to the current date (such as yesterday, tomorrow, next month, etc.)

  • Absolute time periods (such as calendar days, months, and years)

  • Absolute time periods created using specific parts of date/time values (such as the date part of date/time values, hours, etc.)

These time periods are derived from item values and are represented in a View as:

A filter condition or grouping value is created for an item, provided that there’s at least one item value that falls into the corresponding time period. To determine whether an item value falls into a certain time period, a date range is used.

Each item contains date range collections that will be used to determine time periods to be created when data is:

  • Filtered by the item. Use the FilteringDateRanges property to access a collection of filter date ranges.

  • Grouped by the item. Use the GroupingDateRanges property to access a collection of grouping date ranges.

The TcxCustomGridDateRange class represents the base class for all classes that represent date ranges. TcxCustomGridDateRange members allow you to:

  • Determine whether a particular value falls into time periods associated with a date range (Contains).

  • Access the corresponding date range collection and specify a date range’s position in this collection (Container and Index).

  • Obtain the time span and a string representation of a particular time period associated with a date range (GetRangeValue and GetDisplayText).

  • Obtain a grouping value associated with this time period (GetValue

TcxCustomGridDateRange descendants override these members to return values specific to their corresponding date ranges. The “Related Information” section below lists all TcxCustomGridDateRange descendants shipped with the ExpressQuantumGrid Suite.

See Also