Class DateRangePicker

Represents the DateRangePicker UI element

Inheritance

System.Object

CommonControl

DateRangePicker

Implements

System.Web.UI.INamingContainer

System.Web.UI.IPostBackEventHandler

System.Web.UI.IPostBackDataHandler

System.Web.UI.IUrlResolutionService

Inherited Members

CommonControl.RaisePostBackEvent(String)

CommonControl.LoadViewState(Object)

CommonControl.OnInit(EventArgs)

CommonControl.OnLoad(EventArgs)

Namespace: Syncfusion.JavaScript.Web

Assembly: Syncfusion.EJ.Web.dll

Syntax

public class DateRangePicker : CommonControl, INamingContainer, IPostBackEventHandler, IPostBackDataHandler, IUrlResolutionService

Constructors

DateRangePicker()

Declaration

public DateRangePicker()

Properties

AllowEdit

Allow the user interaction directly with the component to edit in textbox.

Declaration

public bool AllowEdit { get; set; }

Property Value

Type	Description
System.Boolean

ClientSideOnBeforeClose

Gets or sets a value indicating this event gets fired before DateRangePicker popup closes.

Declaration

public string ClientSideOnBeforeClose { get; set; }

Property Value

Type	Description
System.String

ClientSideOnBeforeOpen

Gets or sets a value indicating this event gets fired before DateRangePicker popup opens.

Declaration

public string ClientSideOnBeforeOpen { get; set; }

Property Value

Type	Description
System.String

ClientSideOnChange

Gets or sets a value indicating this event gets fired when the date or time value changed in the DateRangePicker textbox.

Declaration

public string ClientSideOnChange { get; set; }

Property Value

Type	Description
System.String

ClientSideOnClick

Gets or sets a value indicating this event gets fired when the DateRangePicker is destroyed successfully.

Declaration

public string ClientSideOnClick { get; set; }

Property Value

Type	Description
System.String

ClientSideOnClose

Gets or sets a value indicating this event gets fired when DateRangePicker popup closes.

Declaration

public string ClientSideOnClose { get; set; }

Property Value

Type	Description
System.String

ClientSideOnCreate

Gets or sets a value indicating this event gets fired when DateRangePicker control is created.

Declaration

public string ClientSideOnCreate { get; set; }

Property Value

Type	Description
System.String

ClientSideOnDestroy

Gets or sets a value indicating this event gets fired when the DateRangePicker is destroyed successfully.

Declaration

public string ClientSideOnDestroy { get; set; }

Property Value

Type	Description
System.String

ClientSideOnOpen

Gets or sets a value indicating this event gets fired when DateRangePicker popup opens.

Declaration

public string ClientSideOnOpen { get; set; }

Property Value

Type	Description
System.String

ClientSideOnSelect

Gets or sets a value indicating this event gets fired when the value is selected from the DateRangePicker dropdown.

Declaration

public string ClientSideOnSelect { get; set; }

Property Value

Type	Description
System.String

CssClass

Gets or sets the root CSS class to DateRangePicker for theme customization.

Declaration

public string CssClass { get; set; }

Property Value

Type	Description
System.String

DateFormat

Gets or sets the date format to be displayed in date picker's input field.

Declaration

public string DateFormat { get; set; }

Property Value

Type	Description
System.String

DateRangePickerButtonText

Gets or sets the value indicating custom text for the buttons inside the DateRangepicker popup.

Declaration

[JsonProperty("buttonText")]
public DateRangeButtonText DateRangePickerButtonText { get; set; }

Property Value

Type	Description
DateRangeButtonText

Enabled

Gets or sets a value indicating whether the control can respond to user interaction.

Declaration

public bool Enabled { get; set; }

Property Value

Type	Description
System.Boolean

EnablePersistence

Gets or set the value indicating DateRangePicker model value even after form post back/browser refresh sustains or not.

Declaration

public bool EnablePersistence { get; set; }

Property Value

Type	Description
System.Boolean

EnableTimePicker

Gets or sets the value for enabling TimePicker in DateRangePicker.

Declaration

public bool EnableTimePicker { get; set; }

Property Value

Type	Description
System.Boolean

EndDate

Gets or sets a value indicating the end date of the calendar of DateRangePicker

Declaration

public DateTime? EndDate { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTime>

Height

Gets or sets the height of the time picker input field.

Declaration

public string Height { get; set; }

Property Value

Type	Description
System.String

Locale

Gets or sets a value to localize the DateRangePicker language and format.

Declaration

public string Locale { get; set; }

Property Value

Type	Description
System.String

Model

Gets or sets the DateRangePicker model object of the DateRangePicker properties.

Declaration

public DateRangePickerProperties Model { get; set; }

Property Value

Type	Description
DateRangePickerProperties

Ranges

Gets or Sets a value indicating the date range in the daterangepicker

Declaration

[JsonProperty("Ranges")]
public List<DateRanges> Ranges { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<DateRanges>

Separator

Gets or Sets the separator between the date ranges

Declaration

public string Separator { get; set; }

Property Value

Type	Description
System.String

ShowPopupButton

Gets or sets the value indicating DateRange icon button in the input field.

Declaration

public bool ShowPopupButton { get; set; }

Property Value

Type	Description
System.Boolean

ShowRoundedCorner

Gets or sets the value indicating the DateRangePicker input field and popup with rounded corners or not

Declaration

public bool ShowRoundedCorner { get; set; }

Property Value

Type	Description
System.Boolean

StartDate

Gets or sets a value indicating the start date of the calendar of DateRangePicker

Declaration

public DateTime? StartDate { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTime>

TimeFormat

Gets or sets the value indicating the time format to be displayed on time picker input field in daterangepicker.

Declaration

public string TimeFormat { get; set; }

Property Value

Type	Description
System.String

Value

Gets or sets the value in the DateRangePicker.

Declaration

public string Value { get; set; }

Property Value

Type	Description
System.String

WatermarkText

Gets or sets the place holder value for DateRangePicker input field.

Declaration

public string WatermarkText { get; set; }

Property Value

Type	Description
System.String

Width

Gets or sets the width of the time picker input field.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String

Methods

DependentScripts()

Specifies the dependent Scripts

Declaration

public List<string> DependentScripts()

Returns

Type	Description
System.Collections.Generic.List<System.String>

GetDependentFiles()

Specifies the dependent files

Declaration

public override List<string> GetDependentFiles()

Returns

Type	Description
System.Collections.Generic.List<System.String>

Overrides

CommonControl.GetDependentFiles()

OnPreRender(EventArgs)

Modifying server controls before sending them to the client.

Declaration

protected override void OnPreRender(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e

PostBackEventHandler(String, Dictionary<String, Object>)

Specifies the handler for server side events.

Declaration

public override void PostBackEventHandler(string EventName, Dictionary<string, object> args)

Parameters

Type	Name	Description
System.String	EventName
System.Collections.Generic.Dictionary<System.String, System.Object>	args

Overrides

CommonControl.PostBackEventHandler(String, Dictionary<String, Object>)

Render()

Renders the DateRangePicker Instance

Declaration

public string Render()

Returns

Type	Description
System.String

Render(HtmlTextWriter)

Declaration

protected override void Render(HtmlTextWriter writer)

Parameters

Type	Name	Description
System.Web.UI.HtmlTextWriter	writer

Overrides

CommonControl.Render(HtmlTextWriter)

UpdateServerModel(Dictionary<String, Object>)

Updates the server model with client model

Declaration

public override void UpdateServerModel(Dictionary<string, object> ClientModel)

Parameters

Type	Name	Description
System.Collections.Generic.Dictionary<System.String, System.Object>	ClientModel

Overrides

CommonControl.UpdateServerModel(Dictionary<String, Object>)

Events

Select

Specifies the server side OnChange event.

Declaration

public event DateRangePicker.DateRangePickerSelectEventHandler Select

Event Type

Type	Description
DateRangePicker.DateRangePickerSelectEventHandler

Implements

System.Web.UI.INamingContainer

System.Web.UI.IPostBackEventHandler

System.Web.UI.IPostBackDataHandler

System.Web.UI.IUrlResolutionService