DateRangePickerModel

Interface represents the DateRangePicker class.

Properties

allowEdit Boolean

Specifies whether the textbox is allowed to be edited by user input or only by selecting a value from the calendar popup.

Default: true

calendarMode String

Specifies the mode of the calendar.

Default: Gregorian

cssClass String

Specifies CSS classes to customize the appearance of the control.

Default: ""

dayHeaderFormat DayHeaderFormat

Specifies the format of the day that is displayed in the header.

Default: Short

enabled Boolean

Specifies whether the control is enabled or disabled, disabled will prevent user interaction.

Default: true

enableRtl Boolean

Specifies whether to render the control in right to left direction.

Default: false

enableState Boolean

Specifies whether to persist the state of the control between page loads.

The following properties will be saved to state.
  • startDate
  • endDate
  • value

Default: false

endDate Date

Specifies the end date of the date range.

Default: null

firstDayOfWeek Number

Specifies the calendar’s first day of the week.

Default: 0

format String DateTimeFormatObject

Specifies the format string or skeleton to be used in the textbox control when entering a value or when a value is selected from the calendar popup.

Default: null

fullScreenMode Boolean

Specifies whether the calendar popup will be opened in full screen mode on a mobile device.

Default: false

htmlAttributes {:}

Specifies additional HTML attributes, such as title, styles, class, id, and name, in a key-value pair format that will be appended to the HTML element. If both the property and equivalent HTML attributes are configured, then the control overrides the property value with the HTML attributes.

Default: {}

keyConfigs {:}

Specifies the key configuration to customize the keyboard shortcuts.

Default: {}

labelType FloatingLabelType

Specifies the condition on when to show the floating label, for example: never, always.

Default: Never

locale String

Specifies the culture and localization value for this control, overriding the globally defined value.

Default: en-US

max Date

Specifies the maximum allowed date that can be selected in the calendar.

Default: 2099, 12, 31

maxDays Number

Specifies the maximum number of days that are allowed in a date range.

Default: null

min Date

Specifies the minimum allowed date that can be selected in the calendar.

Default: 1900, 01, 01

minDays Number

Specifies the minimum number of days that are allowed in a date range.

Default: null

openOnFocus Boolean

Specifies whether to open the calendar popup when the textbox is focused on or only when the calendar open button is clicked.

Default: false

placeholder String

Specifies a short description of what is expected to be entered into the control.

Default: ""

presets PresetsModel[]

Specifies a list of predefined ranges which allow the user to pick from.

Default: null

readonly Boolean

Specifies whether the control is readonly disabling all user interaction with the control.

Default: False

separator String

Specifies the string that will be used between the start and end date.

Default: -

serverTimezoneOffset Number

Specifies the server time zone offset that will be used when processing dates. By default, the date will be processed vase on the system time zone.

Default: null

showClearButton Boolean

Specifies whether to show the clear button or not, allowing the user to clear the current value.

Default: true

showTodayButton Boolean

Specifies whether to show the today button or not.

Default: true

start CalendarView

Specifies the starting view that will be shown when the calendar is rendered.

Default: Month

startDate Date

Specifies the start date of the date range.

Default: null

strictMode Boolean

Specifies whether to require that the entered date is valid and within the min/max range. If a date is not valid, the previous date will be restored.

Default: False

value Date[] DateRange

Specifies the selected start and end date.

Default: null

view CalendarView

Specifies the maximum view level of the calendar. To restrict the view navigation, ensure the view is smaller than the start view.

Default: Month

weekNumber Boolean

Specifies whether the week number of the year will be displayed in the calendar or not.

Default: false

weekRule WeekRule

Specifies the rule for defining the first week of the year.

Default: FirstDay

width String Number

Specifies the width of the control. By default, the width of the control is determined by its parent container. Value can be expressed in percent or pixels.

Default: null

zIndex Number

Specifies the zIndex of the popup.

Default: 1000