TcxGridDateTimeFilter Type

Enumerates date/time filter options for items that display date/time values.

Declaration

TcxGridDateTimeFilter = dxDateRanges.TdxDateTimeFilter;

Referenced Class

Type
TdxDateTimeFilter

Remarks

These options determine time periods to be included into item filter dropdown as filter conditions. A filter condition is added into an item’s filter dropdown, provided that there’s at least one item value that falls into the corresponding time period.

Time periods used as filter conditions include:

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

• Absolute time periods derived from item values using date ranges (such as calendar days, months, and years). In this instance, the corresponding date range is added to an item’s FilteringDateRanges collection.

To specify date/time filter options, use the View’s DateTimeHandling.Filters property.

All available date/time filter options are listed in the following table.

Value	Date Range Used	Meaning
dtfRelativeDays	N/A	Filter conditions represent days relative to the current date, as follows: Yesterday, Today, Tomorrow. String representations of these filter conditions are specified by the scxGridYesterday, scxGridToday, and scxGridTomorrow resource strings, respectively.
dtfRelativeDayPeriods	N/A	Filter conditions represent day periods relative to the current date, as follows: Last 30 days, Last 14 days, Last 7 days, Next 7 days, Next 14 days, Next 30 days. String representations of these filter conditions are specified by the scxGridLast30Days, scxGridLast30Days, scxGridLast7Days, scxGridNext7Days, scxGridNext14Days, and scxGridNext30Days resource strings, respectively.
dtfRelativeWeeks	N/A	Filter conditions represent week periods relative to the current date, as follows: Last two weeks, Last week, This week, Next week, Next two weeks. String representations of these filter items are specified by the scxGridLastTwoWeeks, scxGridLastWeek, scxGridThisWeek, scxGridNextWeek, and scxGridNextTwoWeeks resource strings, respectively.
dtfRelativeMonths	N/A	Filter conditions represent month periods relative to the current date, as follows: Last month, This month, Next month. String representations of these filter items are specified by the scxGridLastMonth, scxGridThisMonth, and scxGridNextMonth resource strings, respectively.
dtfRelativeYears	N/A	Filter conditions represent year periods relative to the current date, as follows: Last year, This year, Next year. String representations of these filter items are specified by the scxGridLastYear, scxGridThisYear, and scxGridNextYear resource strings, respectively.
dtfPastFuture	N/A	Filter conditions represent future or past periods relative to the current date, as follows: Future, Past. String representations of these filter items are specified by the scxGridFuture, and scxGridPast resource strings, respectively.
dtfMonths	TcxGridMonthRange	Filter conditions represent individual months derived from item values. Note that the year part is also taken into account. Use the View’s DateTimeHandling.MonthFormat property to customize the appearance of these filter conditions in filter dropdowns.
dtfYears	TcxGridYearRange	Filter conditions represent individual years derived from item values. Use the View’s DateTimeHandling.YearFormat property to customize the appearance of these filter conditions in filter dropdowns.