DateRangePickerController class

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 rum 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:

• SfDateRangePicker.initialDisplayDate, which used to navigate the date range picker to the specific date initially.
• SfDateRangePicker.initialSelectedDate, which allows to select date programmatically initially on date range picker.
• SfDateRangePicker.initialSelectedDates, which allows to list of select date programmatically initially on date range picker.
• SfDateRangePicker.initialSelectedRange, which allows to select a range of dates programmatically initially on date range picker.
• 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.
• selectedRanges, which allows to select ranges of dates programmatically dynamically on date range picker.
• SfDateRangePicker.selectionMode, which allows to customize the selection mode with available mode options.
• SfDateRangePicker.onViewChanged, the callback which notifies when the current view visible date changed on the date range picker.
• 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 all days when clicking on the day header
• Knowledge base: How to confirm or cancel the selection
• 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
• Knowledge base: How to do programmatic navigation
• Knowledge base: How to programmatically navigate to adjacent dates
• Knowledge base: How to programmatically navigate

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,
       ),
     ),
   );
 }
}

Inheritance

• Object
• DateRangePickerValueChangeNotifier
• DateRangePickerController

Constructors

DateRangePickerController()

Properties

backward ↔ VoidCallback?

Moves to the previous view programmatically with animation by checking that the previous view dates falls between the minimum and maximum date range.

getter/setter pair

displayDate ↔ DateTime?

The first date of the current visible view month, when the MonthViewSettings.numberOfWeeksInView set with default value 6.

getter/setter pair

forward ↔ VoidCallback?

Moves to the next view programmatically with animation by checking that the next view dates falls between the minimum and maximum date range.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

selectedDate ↔ DateTime?

The selected date in the SfDateRangePicker.

getter/setter pair

selectedDates ↔ List<DateTime>?

The list of dates selected in the SfDateRangePicker.

getter/setter pair

selectedRange ↔ PickerDateRange?

selected date range in the SfDateRangePicker.

getter/setter pair

selectedRanges ↔ List<PickerDateRange>?

List of selected ranges in the SfDateRangePicker.

getter/setter pair

view ↔ DateRangePickerView?

The current visible DateRangePickerView of SfDateRangePicker.

getter/setter pair

Methods

addPropertyChangedListener(DateRangePickerValueChangedCallback listener) → void

Calls the listener every time the controller's property changed.

inherited

debugFillProperties(DiagnosticPropertiesBuilder properties) → void

Add additional properties associated with the node.

override

dispose() → void

Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to addListener and removeListener will throw after the object is disposed).

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

notifyPropertyChangedListeners(String value) → void

Call all the registered listeners.

inherited

removePropertyChangedListener(DateRangePickerValueChangedCallback listener) → void

remove the listener used for notify the data source changes.

inherited

toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode

Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.

inherited

toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String

A string representation of this object.

inherited

toStringShort() → String

A brief description of this object, usually just the runtimeType and the hashCode.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited