selectedRanges property

List<PickerDateRange>? get selectedRanges

List of selected ranges in the SfDateRangePicker.

It is only applicable when the selectionMode set as DateRangePickerSelectionMode.multiRange for other selection modes this property will return as null.

Implementation

List<PickerDateRange>? get selectedRanges => _selectedRanges;

set selectedRanges (List<PickerDateRange>? ranges)

Selects the given date ranges programmatically in the SfDateRangePicker by checking that the ranges of dates falls in between the minimum and maximum date range.

If it is not null the widget will render the date selection for the ranges set to this property, even the SfDateRangePicker.initialSelectedRanges is not null.

Note: If any date ranges selected previously, will be removed and the selection will be drawn to the ranges of dates set to this property.

It is only applicable when the selectionMode set as DateRangePickerSelectionMode.multiRange.

See also:

• SfDateRangePicker.initialSelectedRanges, which allows to select a ranges of dates programmatically initially on date range picker.
• selectedDate,which allows to select date programmatically dynamically on date range picker.
• selectedDates, which allows to select dates programmatically dynamically on date range picker.
• selectedRange, which allows to select range of dates programmatically dynamically on date range picker.
• SfDateRangePicker.selectionMode, which allows to customize the selection mode with available mode options.
• SfDateRangePicker.onSelectionChanged, the callback which notifies when the selected cell changed on the the date range picker.
• SfDateRangePicker.showActionButtons, which allows to cancel of confirm the selection in the date range picker.
• SfDateRangePicker.onSubmit, the callback which notifies when the selected value confirmed through confirm button on date range picker.
• SfDateRangePicker.onCancel, the callback which notifies when the selected value canceled and reverted to previous confirmed value through cancel button on date range picker.
• Knowledge base: How to get the selected date
• Knowledge base: How to select a week
• Knowledge base: How to select previous or next dates bases on selected date
• Knowledge base: How to get the start and end date of the selected range
• Knowledge base: How to programmatically select the date

class MyAppState extends State<MyApp> {
DateRangePickerController _pickerController = DateRangePickerController();

 @override
 void initState() {
   _pickerController.selectedRanges = <PickerDateRange>[
     PickerDateRange(DateTime.now().subtract(Duration(days: 4)),
         DateTime.now().add(Duration(days: 4))),
     PickerDateRange(DateTime.now().add(Duration(days: 11)),
         DateTime.now().add(Duration(days: 16)))
   ];
   super.initState();
 }

 @override
 Widget build(BuildContext context) {
   return MaterialApp(
     home: Scaffold(
       body: SfDateRangePicker(
         controller: _pickerController,
         view: DateRangePickerView.month,
         selectionMode: DateRangePickerSelectionMode.multiRange,
       ),
     ),
   );
 }
}

Implementation

set selectedRanges(List<PickerDateRange>? ranges) {
  if (DateRangePickerHelper.isDateRangesEquals(_selectedRanges, ranges)) {
    return;
  }

  _selectedRanges =
      DateRangePickerHelper.cloneList(ranges)?.cast<PickerDateRange>();
  notifyPropertyChangedListeners('selectedRanges');
}