menu

ASP.NET MVC - EJ2

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class DateRangePicker - API Reference

    Show / Hide Table of Contents

    Class DateRangePicker

    Inheritance
    System.Object
    TagHelper
    EJTagHelper
    DateRangePicker
    Inherited Members
    EJTagHelper.GetList()
    EJTagHelper.GetSerializedProperties()
    EJTagHelper.GetScriptString()
    EJTagHelper.GetHtmlAttrString(IDictionary<String, Object>)
    EJTagHelper.TagName
    EJTagHelper.Id
    EJTagHelper.NameSpace
    EJTagHelper.ClassName
    EJTagHelper.IsFor
    EJTagHelper.IsChild
    EJTagHelper.IsComplex
    EJTagHelper.IsCollection
    EJTagHelper.ParentPropertyName
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Syncfusion.EJ2.Calendars
    Assembly: Syncfusion.EJ2.dll
    Syntax
    public class DateRangePicker : EJTagHelper

    Constructors

    DateRangePicker()

    Declaration
    public DateRangePicker()

    Properties

    AllowEdit

    Support for allowEdit has been provided from v16.2.46.

    Declaration
    [HtmlAttributeName("allowEdit")]
    public bool AllowEdit { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is true

    Blur

    Triggers when the control loses the focus.

    Declaration
    [HtmlAttributeName("blur")]
    public string Blur { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    Change

    Triggers when the Calendar value is changed.

    Declaration
    [HtmlAttributeName("change")]
    public string Change { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    Cleared

    Triggers when daterangepicker value is cleared using clear button.

    Declaration
    [HtmlAttributeName("cleared")]
    public string Cleared { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    Close

    Triggers when the DateRangePicker is closed.

    Declaration
    [HtmlAttributeName("close")]
    public string Close { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    Created

    Triggers when Calendar is created.

    Declaration
    [HtmlAttributeName("created")]
    public string Created { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    CssClass

    Sets the root CSS class to the DateRangePicker which allows you to customize the appearance.

    Declaration
    [HtmlAttributeName("cssClass")]
    public string CssClass { get; set; }
    Property Value
    Type Description
    System.String

    The default value is ""

    DayHeaderFormat

    Specifies the format of the day that to be displayed in header. By default, the format is ‘short’. Possible formats are: Short - Sets the short format of day name (like Su ) in day header. Narrow - Sets the single character of day name (like S ) in day header. Abbreviated - Sets the min format of day name (like Sun ) in day header. Wide - Sets the long format of day name (like Sunday ) in day header.

    Declaration
    [HtmlAttributeName("dayHeaderFormat")]
    public DayHeaderFormats DayHeaderFormat { get; set; }
    Property Value
    Type Description
    DayHeaderFormats

    The default value is DayHeaderFormats.Short

    Depth

    Sets the maximum level of view (month, year, decade) in the Calendar. Depth view should be smaller than the start view to restrict its view navigation.

    Declaration
    [HtmlAttributeName("depth")]
    public CalendarView Depth { get; set; }
    Property Value
    Type Description
    CalendarView

    The default value is CalendarView.Month

    Destroyed

    Triggers when Calendar is destroyed.

    Declaration
    [HtmlAttributeName("destroyed")]
    public string Destroyed { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    Enabled

    Specifies the component to be disabled which prevents the DateRangePicker from user interactions.

    Declaration
    [HtmlAttributeName("enabled")]
    public bool Enabled { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is true

    EnablePersistence

    Enable or disable the persisting component's state between the page reloads. If enabled, following list of states will be persisted.

    1. startDate
    2. endDate
    3. value
    Declaration
    [HtmlAttributeName("enablePersistence")]
    public bool EnablePersistence { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is false

    EnableRtl

    Enable or disable rendering component in right to left direction.

    Declaration
    [HtmlAttributeName("enableRtl")]
    public bool EnableRtl { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is false

    EndDate

    Gets or sets the end date of the date range selection.

    Declaration
    [HtmlAttributeName("endDate")]
    public object EndDate { get; set; }
    Property Value
    Type Description
    System.Object

    The default value is null

    FirstDayOfWeek

    Declaration
    [HtmlAttributeName("firstDayOfWeek")]
    public double FirstDayOfWeek { get; set; }
    Property Value
    Type Description
    System.Double

    The default value is Double.NaN

    FloatLabelType

    Specifies the placeholder text to be floated. Possible values are: Never: The label will never float in the input when the placeholder is available. Always: The floating label will always float above the input. Auto: The floating label will float above the input after focusing or entering a value in the input.

    Declaration
    [HtmlAttributeName("floatLabelType")]
    public FloatLabelType FloatLabelType { get; set; }
    Property Value
    Type Description
    FloatLabelType

    The default value is Syncfusion.EJ2.Inputs.FloatLabelType.Never

    Focus

    Triggers when the control gets focus.

    Declaration
    [HtmlAttributeName("focus")]
    public string Focus { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    Format

    Sets or gets the required date format to the start and end date string.

    For more details refer to Formatsample.

    Declaration
    [HtmlAttributeName("format")]
    public string Format { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    FullScreenMode

    Specifies the component popup display full screen in mobile devices.

    Declaration
    [HtmlAttributeName("fullScreenMode")]
    public bool FullScreenMode { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is false

    HtmlAttributes

    You can add the additional html attributes such as disabled, value etc., to the element. If you configured both property and equivalent html attribute then the component considers the property value. {% codeBlock src='daterangepicker/htmlAttributes/index.md' %}{% endcodeBlock %}

    Declaration
    [HtmlAttributeName("htmlAttributes")]
    public object HtmlAttributes { get; set; }
    Property Value
    Type Description
    System.Object

    The default value is null

    KeyConfigs

    Customizes the key actions in DateRangePicker. For example, when using German keyboard, the key actions can be customized using these shortcuts.

    Declaration
    [HtmlAttributeName("keyConfigs")]
    public object KeyConfigs { get; set; }
    Property Value
    Type Description
    System.Object

    The default value is null

    Locale

    Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

    Declaration
    [HtmlAttributeName("locale")]
    public string Locale { get; set; }
    Property Value
    Type Description
    System.String

    The default value is "en-US"

    Max

    Gets or sets the maximum date that can be selected in the calendar-popup.

    Declaration
    [HtmlAttributeName("max")]
    public object Max { get; set; }
    Property Value
    Type Description
    System.Object

    The default value is null

    MaxDays

    Declaration
    [HtmlAttributeName("maxDays")]
    public int MaxDays { get; set; }
    Property Value
    Type Description
    System.Int32

    The default value is null

    Min

    Gets or sets the minimum date that can be selected in the calendar-popup.

    Declaration
    [HtmlAttributeName("min")]
    public object Min { get; set; }
    Property Value
    Type Description
    System.Object

    The default value is null

    MinDays

    Declaration
    [HtmlAttributeName("minDays")]
    public int MinDays { get; set; }
    Property Value
    Type Description
    System.Int32

    The default value is null

    Navigated

    Triggers when the Calendar is navigated to another view or within the same level of view.

    Declaration
    [HtmlAttributeName("navigated")]
    public string Navigated { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    Open

    Triggers when the DateRangePicker is opened.

    Declaration
    [HtmlAttributeName("open")]
    public string Open { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    OpenOnFocus

    By default, the popup opens while clicking on the daterangepicker icon. If you want to open the popup while focusing the daterange input then specify its value as true.

    Declaration
    [HtmlAttributeName("openOnFocus")]
    public bool OpenOnFocus { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is false

    Placeholder

    Specifies the placeholder text that need to be displayed in the DateRangePicker component.

    Declaration
    [HtmlAttributeName("placeholder")]
    public string Placeholder { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    Presets

    Declaration
    [HtmlAttributeName("presets")]
    public List<DateRangePickerPreset> Presets { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<DateRangePickerPreset>

    The default value is null

    Readonly

    Denies the editing the ranges in the DateRangePicker component.

    Declaration
    [HtmlAttributeName("readonly")]
    public bool Readonly { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is false

    RenderDayCell

    Triggers when each day cell of the Calendar is rendered.

    Declaration
    [HtmlAttributeName("renderDayCell")]
    public string RenderDayCell { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    Select

    Triggers on selecting the start and end date.

    Declaration
    [HtmlAttributeName("select")]
    public string Select { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    Separator

    Sets or gets the string that used between the start and end date string.

    Declaration
    [HtmlAttributeName("separator")]
    public string Separator { get; set; }
    Property Value
    Type Description
    System.String

    The default value is "-"

    ServerTimezoneOffset

    By default, the date value will be processed based on system time zone. If you want to process the initial date value using server time zone then specify the time zone value to serverTimezoneOffset property.

    Declaration
    [HtmlAttributeName("serverTimezoneOffset")]
    public double ServerTimezoneOffset { get; set; }
    Property Value
    Type Description
    System.Double

    The default value is Double.NaN

    ShowClearButton

    Specifies whether to show or hide the clear icon

    Declaration
    [HtmlAttributeName("showClearButton")]
    public bool ShowClearButton { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is true

    Start

    Specifies the initial view of the Calendar when it is opened. With the help of this property, initial view can be changed to year or decade view.

    Declaration
    [HtmlAttributeName("start")]
    public CalendarView Start { get; set; }
    Property Value
    Type Description
    CalendarView

    The default value is CalendarView.Month

    StartDate

    Gets or sets the start date of the date range selection.

    Declaration
    [HtmlAttributeName("startDate")]
    public object StartDate { get; set; }
    Property Value
    Type Description
    System.Object

    The default value is null

    StrictMode

    Declaration
    [HtmlAttributeName("strictMode")]
    public bool StrictMode { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is false

    Value

    Gets or sets the start and end date of the Calendar. {% codeBlock src='daterangepicker/value/index.md' %}{% endcodeBlock %}

    Declaration
    [HtmlAttributeName("value")]
    public object Value { get; set; }
    Property Value
    Type Description
    System.Object

    The default value is null

    WeekNumber

    Declaration
    [HtmlAttributeName("weekNumber")]
    public bool WeekNumber { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is false

    WeekRule

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

    Declaration
    [HtmlAttributeName("weekRule")]
    public WeekRule WeekRule { get; set; }
    Property Value
    Type Description
    WeekRule

    The default value is WeekRule.FirstDay

    Width

    Specifies the width of the DateRangePicker component.

    Declaration
    [HtmlAttributeName("width")]
    public string Width { get; set; }
    Property Value
    Type Description
    System.String

    The default value is ""

    ZIndex

    specifies the z-index value of the dateRangePicker popup element.

    Declaration
    [HtmlAttributeName("zIndex")]
    public int ZIndex { get; set; }
    Property Value
    Type Description
    System.Int32

    The default value is 1000

    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved