DateRangePickerBuilder

Properties

WriteAction - Func

Methods

DisableDates(System.Collections.Generic.IEnumerable)

Specifies the disabled dates in the DateRangePicker widget.

Parameters

disableDates - System.Collections.Generic.IEnumerable<String>

RETURNS

A reference to the current DateRangePickerBuilder instance, to allow for method chaining.

DisableDates(System.DayOfWeek[])

Specifies the disabled dates in the DateRangePicker widget.

Parameters

days - System.DayOfWeek[]

RETURNS

A reference to the current DateRangePickerBuilder instance, to allow for method chaining.

Example

Razor

 
                @(Html.Kendo().DateRangePicker()
                        .Name("DateRangePicker")
                        .DisableDates(DayOfWeek.Saturday, DayOfWeek.Sunday)
                )
             

DisableDates(System.String)

Specifies the disabled dates in the DateRangePicker widget using a function.

Parameters

handler - System.String

RETURNS

A reference to the current DateRangePickerBuilder instance, to allow for method chaining.

Example

Razor

 
                @(Html.Kendo().DateRangePicker()
                        .Name("DateRangePicker")
                        .DisableDates("disableDates")
                )
             

MonthTemplate(System.Action)

Specifies the month template that will be displayed in the popup calendar.

Parameters

configurator - System.Action<MonthTemplateBuilder>

The configurator for the monthtemplate setting.

RETURNS

A reference to the current DateRangePickerBuilder instance, to allow for method chaining.

Example

Razor

 
                 @(Html.Kendo().DateRangePicker()
                        .Name("DateRangePicker")
                        .MonthTemplate(m => m.Content("#= data.value #"))
                )
             

AllowReverse(System.Boolean)

Enables the user to select an end date that is before the start date.

Parameters

value - System.Boolean

The value for AllowReverse

RETURNS

Returns the current DateRangePickerBuilder instance.

AllowReverse()

Enables the user to select an end date that is before the start date.

RETURNS

Returns the current DateRangePickerBuilder instance.

AutoClose(System.Boolean)

Specifies whether the calendar popup should close automatically when a range is selected.

Parameters

value - System.Boolean

The value for AutoClose

RETURNS

Returns the current DateRangePickerBuilder instance.

AdaptiveTitle(System.String)

Allows customization of the title's text in the adaptive view of the component.

Parameters

value - System.String

The value for AdaptiveTitle

RETURNS

Returns the current DateRangePickerBuilder instance.

AdaptiveSubtitle(System.String)

Allows customization of the subtitle's text in the adaptive view of the component.

Parameters

value - System.String

The value for AdaptiveSubtitle

RETURNS

Returns the current DateRangePickerBuilder instance.

ARIATemplate(System.String)

Specifies a template used to populate value of the aria-label attribute of the currently focused cell of the calendar..The parameters available for the template are: current - The current focused date.; valueType - The focused item value type - month, year and etc. or text - A text representing the focused value..

Parameters

value - System.String

The value for ARIATemplate

RETURNS

Returns the current DateRangePickerBuilder instance.

ARIATemplateId(System.String)

Specifies a template used to populate value of the aria-label attribute of the currently focused cell of the calendar..The parameters available for the template are: current - The current focused date.; valueType - The focused item value type - month, year and etc. or text - A text representing the focused value..

Parameters

templateId - System.String

The ID of the template element for ARIATemplate

RETURNS

Returns the current DateRangePickerBuilder instance.

ARIATemplateView(Microsoft.AspNetCore.Html.IHtmlContent)

Specifies a template used to populate value of the aria-label attribute of the currently focused cell of the calendar..The parameters available for the template are: current - The current focused date.; valueType - The focused item value type - month, year and etc. or text - A text representing the focused value..

Parameters

templateView - Microsoft.AspNetCore.Html.IHtmlContent

The view that contains the template for ARIATemplate

RETURNS

Returns the current DateRangePickerBuilder instance.

ARIATemplateHandler(System.String)

Specifies a template used to populate value of the aria-label attribute of the currently focused cell of the calendar..The parameters available for the template are: current - The current focused date.; valueType - The focused item value type - month, year and etc. or text - A text representing the focused value..

Parameters

templateHandler - System.String

The handler that returs the template for ARIATemplate

RETURNS

Returns the current DateRangePickerBuilder instance.

ARIATemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)

Specifies a template used to populate value of the aria-label attribute of the currently focused cell of the calendar..The parameters available for the template are: current - The current focused date.; valueType - The focused item value type - month, year and etc. or text - A text representing the focused value..

Parameters

template - TemplateBuilder<TModel>

A Template component that configures the ariatemplate.

RETURNS

Returns the current DateRangePickerBuilder instance.

AutoAdjust(System.Boolean)

If this property is enabled and you have configured min and/or max values, and the user enters a value that falls out of that range, the value will automatically be set to either the minimum or maximum allowed value.

Parameters

value - System.Boolean

The value for AutoAdjust

RETURNS

Returns the current DateRangePickerBuilder instance.

CalendarButton(System.Boolean)

If this configuration is enabled, a calendar button will appear inside the date inputs. This is similar to the calendar button in the DatePicker component. The calendar popup will be opened only when the button is clicked. Clicking inside the input itself will have no effect.

Parameters

value - System.Boolean

The value for CalendarButton

RETURNS

Returns the current DateRangePickerBuilder instance.

CalendarButton()

If this configuration is enabled, a calendar button will appear inside the date inputs. This is similar to the calendar button in the DatePicker component. The calendar popup will be opened only when the button is clicked. Clicking inside the input itself will have no effect.

RETURNS

Returns the current DateRangePickerBuilder instance.

ClearButton(System.Boolean)

If this configuration is enabled, a clear button will appear in the date inputs where a date is selected. Clicking on the clear button will remove the selected date from the input.

Parameters

value - System.Boolean

The value for ClearButton

RETURNS

Returns the current DateRangePickerBuilder instance.

ClearButton()

If this configuration is enabled, a clear button will appear in the date inputs where a date is selected. Clicking on the clear button will remove the selected date from the input.

RETURNS

Returns the current DateRangePickerBuilder instance.

Culture(System.String)

Specifies the culture info used by the widget.

Parameters

value - System.String

The value for Culture

RETURNS

Returns the current DateRangePickerBuilder instance.

Dates(System.DateTime[])

Specifies a list of dates, which will be passed to the month template.

Parameters

value - System.DateTime[]

The value for Dates

RETURNS

Returns the current DateRangePickerBuilder instance.

EndField(System.String)

Specifies the end field name for model binding.

Parameters

value - System.String

The value for EndField

RETURNS

Returns the current DateRangePickerBuilder instance.

Footer(System.String)

The template which renders the footer of the calendar. If false, the footer will not be rendered.

Parameters

value - System.String

The value for Footer

RETURNS

Returns the current DateRangePickerBuilder instance.

Format(System.String)

Specifies the format, which is used to format the value of the DateRangePicker displayed in the input. The format also will be used to parse the input.For more information on date and time formats please refer to Date Formatting.

Parameters

value - System.String

The value for Format

RETURNS

Returns the current DateRangePickerBuilder instance.

InputMode(System.String)

Specifies the inputmode attribute of the inner <input /> element. It is used to specify the type of on-screen keyboard that should be displayed when the user focuses the input.

Parameters

value - System.String

The value for InputMode

RETURNS

Returns the current DateRangePickerBuilder instance.

Max(System.DateTime)

Specifies the maximum date, which the calendar can show.

Parameters

value - System.DateTime

The value for Max

RETURNS

Returns the current DateRangePickerBuilder instance.

Messages(System.Action)

Allows localization of the strings that are used in the widget.

Parameters

configurator - System.Action<DateRangePickerMessagesSettingsBuilder>

The configurator for the messages setting.

RETURNS

Returns the current instance of DateRangePickerBuilder .

Min(System.DateTime)

Specifies the minimum date that the calendar can show.

Parameters

value - System.DateTime

The value for Min

RETURNS

Returns the current DateRangePickerBuilder instance.

Labels(System.Boolean)

Determines if the labels for the inputs will be visible.

Parameters

value - System.Boolean

The value for Labels

RETURNS

Returns the current DateRangePickerBuilder instance.

WeekNumber(System.Boolean)

If set to true a week of the year will be shown on the left side of the calendar. It is possible to define a template in order to customize what will be displayed.

Parameters

value - System.Boolean

The value for WeekNumber

RETURNS

Returns the current DateRangePickerBuilder instance.

WeekNumber()

If set to true a week of the year will be shown on the left side of the calendar. It is possible to define a template in order to customize what will be displayed.

RETURNS

Returns the current DateRangePickerBuilder instance.

Range(System.Action)

Configures the Kendo UI DateRangePicker range settings.

Parameters

configurator - System.Action<DateRangePickerRangeSettingsBuilder>

The configurator for the range setting.

RETURNS

Returns the current instance of DateRangePickerBuilder .

StartField(System.String)

Specifies the start field name for model binding.

Parameters

value - System.String

The value for StartField

RETURNS

Returns the current DateRangePickerBuilder instance.

Start(Kendo.Mvc.UI.CalendarView)

Parameters

value - CalendarView

The value for Start

RETURNS

Returns the current DateRangePickerBuilder instance.

Depth(Kendo.Mvc.UI.CalendarView)

Specifies the navigation depth.

Parameters

value - CalendarView

The value for Depth

RETURNS

Returns the current DateRangePickerBuilder instance.

Size(Kendo.Mvc.UI.ComponentSize)

Sets the size of the component.

Parameters

value - ComponentSize

The value for Size

RETURNS

Returns the current DateRangePickerBuilder instance.

Rounded(Kendo.Mvc.UI.Rounded)

Sets a value controlling the border radius.

Parameters

value - Rounded

The value for Rounded

RETURNS

Returns the current DateRangePickerBuilder instance.

FillMode(Kendo.Mvc.UI.FillMode)

Sets a value controlling how the color is applied.

Parameters

value - FillMode

The value for FillMode

RETURNS

Returns the current DateRangePickerBuilder instance.

AdaptiveMode(Kendo.Mvc.UI.AdaptiveMode)

Specifies the adaptive rendering of the component.

Parameters

value - AdaptiveMode

The value for AdaptiveMode

RETURNS

Returns the current DateRangePickerBuilder instance.

Events(System.Action)

Configures the client-side events.

Parameters

configurator - System.Action<DateRangePickerEventBuilder>

The client events action.

RETURNS

Returns the current DateRangePickerBuilder instance.

Example

Razor

 
            @(Html.Kendo().DateRangePicker()
                  .Name("DateRangePicker")
                  .Events(events => events
                      .Change("onChange")
                  )
            )
             

UseMvvmInitialization(System.Boolean)

Specifies if the component should be initialized through MVVM on the client.

Parameters

value - System.Boolean

The value.

RETURNS

Returns the current instance.

UseMvvmInitialization()

Specifies if the component should be initialized through MVVM on the client.

RETURNS

Returns the current instance.

ToComponent()

Returns the internal view component.

RETURNS

The instance that represents the component.

Expression(System.String)

Sets the name of the component.

Parameters

modelExpression - System.String

RETURNS

Returns the current instance.

Explorer(Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer)

Sets the name of the component.

Parameters

modelExplorer - Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer

RETURNS

Returns the current instance.

Name(System.String)

Sets the name of the component.

Parameters

componentName - System.String

The name.

RETURNS

Returns the current instance.

Deferred(System.Boolean)

Suppress initialization script rendering. Note that this options should be used in conjunction with

Parameters

deferred - System.Boolean

RETURNS

Returns a DeferredWidgetBuilder instance.

HtmlAttributes(System.Object)

Sets the HTML attributes.

Parameters

attributes - System.Object

The HTML attributes.

RETURNS

Returns the current instance.

HtmlAttributes(System.Collections.Generic.IDictionary)

Sets the HTML attributes.

Parameters

attributes - System.Collections.Generic.IDictionary<String,Object>

The HTML attributes.

RETURNS

Returns the current instance.

ScriptAttributes(System.Object,System.Boolean)

Sets the JavaScript attributes to the initialization script.

Parameters

attributes - System.Object

The JavaScript attributes.

overrideAttributes - System.Boolean

Argument which determines whether attributes should be overriden.

RETURNS

Returns the current instance.

ScriptAttributes(System.Collections.Generic.IDictionary,System.Boolean)

Sets the JavaScript attributes to the initialization script.

Parameters

attributes - System.Collections.Generic.IDictionary<String,Object>

The JavaScript attributes.

overrideAttributes - System.Boolean

Argument which determines whether attributes should be overriden.

RETURNS

Returns the current instance.

Render()

Renders the component in place.

ToHtmlString()

Returns the HTML representation of the component.

WriteTo(System.IO.TextWriter,System.Text.Encodings.Web.HtmlEncoder)

Parameters

writer - System.IO.TextWriter

encoder - System.Text.Encodings.Web.HtmlEncoder

ToClientTemplate()

Returns the client template for the component.

AsModule(System.Boolean)

Specifies whether the initialization script of the component will be rendered as a JavaScript module.

Parameters

value - System.Boolean

RETURNS

Returns the current instance.