Date-time Drop-down Filter

• Apr 01, 2021
• 4 minutes to read

The GridControl provides a drop-down calendar for date-time columns. You can use the ColumnBase.FilterPopupMode property to change the calendar’s predefined values.

The following table lists the date-time column’s drop-down modes:

|

Mode

|

Image

|

Description

|

Notes

| | --- | --- | --- | --- | |

DateSmart

(default)

|

|

The drop-down filter provides a built-in calendar and checkboxes to select non-intersecting date intervals.

If there is no underlying data in a date range, the corresponding checkbox is hidden.

All the checkboxes are visible when the values in the date-time column are set to null.

|

When the ColumnBase.ShowEmptyDateFilter property is false :

• If AllowedDateTimeFilters.MultipleDateRanges is disabled, the calendar does not allow you to select multiple date ranges.
• If AllowedDateTimeFilters.MultipleDateRanges and AllowedDateTimeFilters.SingleDateRange are disabled, the calendar is hidden.
• If an AllowedDateTimeFilters filter criteria is disabled (except the AllowedDateTimeFilters.MultipleDateRanges and AllowedDateTimeFilters.SingleDateRange), the corresponding item is hidden.
• If the ColumnBase.AllowedDateTimeFilters property is None , the filter button is hidden.

When the ColumnBase.ShowEmptyDateFilter property is true :

• If AllowedDateTimeFilters.MultipleDateRanges is disabled, the calendar does not allow you to choose multiple date ranges.
• If AllowedDateTimeFilters.MultipleDateRanges and AllowedDateTimeFilters.SingleDateRange are disabled, the calendar is hidden.
• If an AllowedDateTimeFilters filter criteria is disabled (except the AllowedDateTimeFilters.MultipleDateRanges and AllowedDateTimeFilters.SingleDateRange), the corresponding item is hidden.
• If AllowedUnaryFilters.IsNull is disabled, the Empty item is hidden.
• If the ColumnBase.AllowedDateTimeFilters property is None and AllowedUnaryFilters.IsNull is disabled, the filter button is hidden.

| |

Date

|

|

This mode is equivalent to DateSmart regarding the drop-down filter’s appearance.

The drop-down filter displays all the checkboxes, even if there is no data in the corresponding date range.

|

When the ColumnBase.ShowEmptyDateFilter property is false :

• If AllowedDateTimeFilters.MultipleDateRanges is disabled, the calendar does not allow you to select multiple date ranges.
• If AllowedDateTimeFilters.MultipleDateRanges and AllowedDateTimeFilters.SingleDateRange are disabled, the calendar is hidden.
• If an AllowedDateTimeFilters filter criterion is disabled (except the AllowedDateTimeFilters.MultipleDateRanges and AllowedDateTimeFilters.SingleDateRange), the corresponding item is hidden.
• If the ColumnBase.AllowedDateTimeFilters property is None , the filter button is hidden.

When the ColumnBase.ShowEmptyDateFilter property is true :

• If AllowedDateTimeFilters.MultipleDateRanges is disabled, the calendar does not allow you to select multiple date ranges.
• If AllowedDateTimeFilters.MultipleDateRanges and AllowedDateTimeFilters.SingleDateRange are disabled, the calendar is hidden.
• If an AllowedDateTimeFilters filter criterion is disabled (except the AllowedDateTimeFilters.MultipleDateRanges and AllowedDateTimeFilters.SingleDateRange), the corresponding item is hidden.
• If AllowedUnaryFilters.IsNull is disabled, the Empty item is hidden.
• If the ColumnBase.AllowedDateTimeFilters property is None and AllowedUnaryFilters.IsNull is disabled, the filter button is hidden.

| |

DateCompact

|

|

The drop-down filter does not display predefined values.

|

When the ColumnBase.ShowEmptyDateFilter property is false :

• If AllowedDateTimeFilters.MultipleDateRanges is disabled, the calendar does not allow you to select multiple date ranges.
• If AllowedDateTimeFilters.MultipleDateRanges and AllowedDateTimeFilters.SingleDateRange are disabled, the filter button is hidden.

When the ColumnBase.ShowEmptyDateFilter property is true :

• If AllowedDateTimeFilters.MultipleDateRanges is disabled, the calendar is hidden.
• If AllowedUnaryFilters.IsNull is disabled, the Empty item is hidden.
• If AllowedDateTimeFilters.MultipleDateRanges and AllowedUnaryFilters.IsNull are disabled, the filter button is hidden.

| |

DateAlt

|

|

This mode is equivalent to DateSmart , but with a different set of filters: Today, This week, This month, Next month, etc.

|

When the ColumnBase.ShowEmptyDateFilter property is false :

• If AllowedDateTimeFilters.MultipleDateRanges is disabled, the calendar does not allow you to select multiple date ranges.
• If AllowedDateTimeFilters.MultipleDateRanges and AllowedDateTimeFilters.SingleDateRange are disabled, the calendar is hidden.
• If AllowedDateTimeFilters.IsToday is disabled, the IsToday item is hidden.
• If AllowedDateTimeFilters.IsNextWeek is disabled, the IsNextWeek item is hidden.
• If AllowedDateTimeFilters.MultipleDateRanges, AllowedDateTimeFilters.SingleDateRange, AllowedDateTimeFilters.IsToday, and AllowedDateTimeFilters.IsNextWeek are disabled, the filter button is hidden.

When the ColumnBase.ShowEmptyDateFilter property is true :

• If AllowedDateTimeFilters.MultipleDateRanges is disabled, the calendar does not allow you to select multiple date ranges.
• If AllowedDateTimeFilters.MultipleDateRanges and AllowedDateTimeFilters.SingleDateRange are disabled, the calendar is hidden.
• If AllowedDateTimeFilters.IsToday is disabled, the IsToday item is hidden.
• If AllowedDateTimeFilters.IsNextWeek is disabled, the IsNextWeek item is hidden.
• If AllowedUnaryFilters.IsNull is disabled, the Empty item is hidden.
• If AllowedDateTimeFilters.MultipleDateRanges, AllowedDateTimeFilters.SingleDateRange, AllowedDateTimeFilters.IsToday, AllowedDateTimeFilters.IsNextWeek, and AllowedUnaryFilters.IsNull are disabled, the filter button is hidden.

|