controller property Null safety

DateRangePickerController? controller
final

An object that used for programmatic date navigation, date and range selection and view switching in SfDateRangePicker.

A DateRangePickerController served for several purposes. It can be used to selected dates and ranges programmatically on SfDateRangePicker by using thecontroller.selectedDate, controller.selectedDates, controller.selectedRange, controller.selectedRanges. It can be used to change the SfDateRangePicker view by using the controller.view property. It can be used to navigate to specific date by using the controller.displayDate property.

Listening to property changes:

The DateRangePickerController is a listenable. It notifies it's listeners whenever any of attached SfDateRangePicker`s selected date, display date and view changed (i.e: selecting a different date, swiping to next/previous view and navigates to different view] in in SfDateRangePicker.

Navigates to different view:

The SfDateRangePicker visible view can be changed by using the Controller.view property, the property allow to change the view of SfDateRangePicker programmatically on initial load and in run time.

Programmatic selection:

In SfDateRangePicker selecting dates programmatically can be achieved by using the controller.selectedDate, controller.selectedDates, controller.selectedRange, controller.selectedRanges which allows to select the dates or ranges programmatically on SfDateRangePicker on initial load and in run time.

Defaults to null.

See also:

This example demonstrates how to use the SfDateRangePickerController for SfDateRangePicker.


class MyApp extends StatefulWidget {
 @override
 MyAppState createState() => MyAppState();
}

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

 @override
 void initState() {
   _pickerController.selectedDates = <DateTime>[
     DateTime.now().add(Duration(days: 2)),
     DateTime.now().add(Duration(days: 4)),
     DateTime.now().add(Duration(days: 7)),
     DateTime.now().add(Duration(days: 11))
   ];
   _pickerController.displayDate = DateTime.now();
   _pickerController.addPropertyChangedListener(handlePropertyChange);
   super.initState();
 }

 void handlePropertyChange(String propertyName) {
   if (propertyName == 'selectedDates') {
     final List<DateTime> selectedDates =
     _pickerController.selectedDates!;
   } else if (propertyName == 'displayDate') {
     final DateTime displayDate = _pickerController.displayDate!;
   }
 }

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

Implementation

final DateRangePickerController? controller;