Class DateRangePickerPropertiesBuilder

Inheritance

System.Object

DateRangePickerPropertiesBuilder

Implements

IPropertiesBuilder

System.Web.IHtmlString

Inherited Members

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.JavaScript

Assembly: Syncfusion.EJ.dll

Syntax

public class DateRangePickerPropertiesBuilder : IPropertiesBuilder, IHtmlString

Constructors

DateRangePickerPropertiesBuilder()

Initializes a new instance of the DateRangePickerPropertiesBuilder class.

Declaration

public DateRangePickerPropertiesBuilder()

DateRangePickerPropertiesBuilder(DateRangePicker)

Initializes a new instance of the DateRangePickerPropertiesBuilder class by the specified DateRangePicker object.

Declaration

public DateRangePickerPropertiesBuilder(DateRangePicker dateRangePicker)

Parameters

Type	Name	Description
DateRangePicker	dateRangePicker

Fields

dateRangePicker

Specifies the instance of the DateRangePicker class.

Declaration

public DateRangePicker dateRangePicker

Field Value

Type	Description
DateRangePicker

Properties

Items

Specifies the collection of dates as special dates.

Declaration

public List<DateRanges> Items { get; set; }

Property Value

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

Methods

AllowEdit()

Allows or restricts directly editing in textbox of DateRangePicker.

Declaration

public DateRangePickerPropertiesBuilder AllowEdit()

Returns

Type	Description
DateRangePickerPropertiesBuilder

AllowEdit(Boolean)

Used to allow or restrict the editing in DateRangePicker input field directly

Declaration

public DateRangePickerPropertiesBuilder AllowEdit(bool allowEdit)

Parameters

Type	Name	Description
System.Boolean	allowEdit

Returns

Type	Description
DateRangePickerPropertiesBuilder

ClientSideEvents(Action<DateRangePickerClientSideEventsBuilder>)

Specifies to trigger the DateRangePicker client side events.

Declaration

public DateRangePickerPropertiesBuilder ClientSideEvents(Action<DateRangePickerClientSideEventsBuilder> clientSideEvents)

Parameters

Type	Name	Description
System.Action<DateRangePickerClientSideEventsBuilder>	clientSideEvents

Returns

Type	Description
DateRangePickerPropertiesBuilder

CssClass(String)

Specifies the root CSS class to date range picker for theme customization.

Declaration

public DateRangePickerPropertiesBuilder CssClass(string cssClass)

Parameters

Type	Name	Description
System.String	cssClass

Returns

Type	Description
DateRangePickerPropertiesBuilder

DateFormat(String)

Displays the specified date format in the input field of the date range picker.

Declaration

public DateRangePickerPropertiesBuilder DateFormat(string dateFormat)

Parameters

Type	Name	Description
System.String	dateFormat

Returns

Type	Description
DateRangePickerPropertiesBuilder

DateRangePickerButtonText(Action<DateRangeButtonTextBuilder>)

Specifies the custom text for the buttons inside the DateRangePicker popup.

Declaration

public DateRangePickerPropertiesBuilder DateRangePickerButtonText(Action<DateRangeButtonTextBuilder> DateRangeText)

Parameters

Type	Name	Description
System.Action<DateRangeButtonTextBuilder>	DateRangeText

Returns

Type	Description
DateRangePickerPropertiesBuilder

Enabled()

Allows the date range picker to respond for user interaction.

Declaration

public DateRangePickerPropertiesBuilder Enabled()

Returns

Type	Description
DateRangePickerPropertiesBuilder

Enabled(Boolean)

Allows the date range picker to respond for user interaction with specified boolean argument.

Declaration

public DateRangePickerPropertiesBuilder Enabled(bool enabled)

Parameters

Type	Name	Description
System.Boolean	enabled

Returns

Type	Description
DateRangePickerPropertiesBuilder

EnablePersistence()

Specifies to persists the DateRangePicker model value upon form post or browser refresh.

Declaration

public DateRangePickerPropertiesBuilder EnablePersistence()

Returns

Type	Description
DateRangePickerPropertiesBuilder

EnablePersistence(Boolean)

Sustain the entire widget model of DateRangePicker even after form post or browser refresh

Declaration

public DateRangePickerPropertiesBuilder EnablePersistence(bool enablePersistence)

Parameters

Type	Name	Description
System.Boolean	enablePersistence

Returns

Type	Description
DateRangePickerPropertiesBuilder

EnableTimePicker()

Allows to embed the Timepicker align with the calendars in the page.

Declaration

public DateRangePickerPropertiesBuilder EnableTimePicker()

Returns

Type	Description
DateRangePickerPropertiesBuilder

EnableTimePicker(Boolean)

Allows to embed the Timepicker align with the calendars in the page

Declaration

public DateRangePickerPropertiesBuilder EnableTimePicker(bool enableTimePicker)

Parameters

Type	Name	Description
System.Boolean	enableTimePicker

Returns

Type	Description
DateRangePickerPropertiesBuilder

EndDate(DateTime)

Specifies the end date of date ranges in the calendar with the specified DateTime argument.

Declaration

public DateRangePickerPropertiesBuilder EndDate(DateTime endDate)

Parameters

Type	Name	Description
System.DateTime	endDate

Returns

Type	Description
DateRangePickerPropertiesBuilder

EndDate(String)

Specifies the end date of date ranges in the calendar with the specified string argument.

Declaration

public DateRangePickerPropertiesBuilder EndDate(string endDate)

Parameters

Type	Name	Description
System.String	endDate

Returns

Type	Description
DateRangePickerPropertiesBuilder

Height(String)

Sets the height of the DateRangePicker input field.

Declaration

public DateRangePickerPropertiesBuilder Height(string height)

Parameters

Type	Name	Description
System.String	height

Returns

Type	Description
DateRangePickerPropertiesBuilder

HtmlAttributes(IDictionary<String, Object>)

Specifies to map the field of html attributes.

Declaration

public DateRangePickerPropertiesBuilder HtmlAttributes(IDictionary<string, object> itemHtmlAttributes)

Parameters

Type	Name	Description
System.Collections.Generic.IDictionary<System.String, System.Object>	itemHtmlAttributes

Returns

Type	Description
DateRangePickerPropertiesBuilder

Locale(String)

Specifies to display the DateTimePicker in the specified culture.

Declaration

public DateRangePickerPropertiesBuilder Locale(string locale)

Parameters

Type	Name	Description
System.String	locale

Returns

Type	Description
DateRangePickerPropertiesBuilder

Ranges(Action<RangesAdder>)

Specifies the special dates in the date picker calendar.

Declaration

public DateRangePickerPropertiesBuilder Ranges(Action<RangesAdder> fields)

Parameters

Type	Name	Description
System.Action<RangesAdder>	fields

Returns

Type	Description
DateRangePickerPropertiesBuilder

Render()

Renders the DateRangePicker instance.

Declaration

public void Render()

Separator(String)

Specifies the separator between the dates in the value.

Declaration

public DateRangePickerPropertiesBuilder Separator(string separator)

Parameters

Type	Name	Description
System.String	separator

Returns

Type	Description
DateRangePickerPropertiesBuilder

ShowPopupButton()

Shows the DateRange icon button in the input field.

Declaration

public DateRangePickerPropertiesBuilder ShowPopupButton()

Returns

Type	Description
DateRangePickerPropertiesBuilder

ShowPopupButton(Boolean)

It allow us to show/hide the DateRange icon in the rightside of textbox of DaterangePicker

Declaration

public DateRangePickerPropertiesBuilder ShowPopupButton(bool showPopupButton)

Parameters

Type	Name	Description
System.Boolean	showPopupButton

Returns

Type	Description
DateRangePickerPropertiesBuilder

ShowRoundedCorner()

Changes the sharped edges into rounded corner for the DateRangePicker textbox and popup.

Declaration

public DateRangePickerPropertiesBuilder ShowRoundedCorner()

Returns

Type	Description
DateRangePickerPropertiesBuilder

ShowRoundedCorner(Boolean)

Specifies the DateRangePicker input field and popup with rounded corners.

Declaration

public DateRangePickerPropertiesBuilder ShowRoundedCorner(bool showRoundedCorner)

Parameters

Type	Name	Description
System.Boolean	showRoundedCorner

Returns

Type	Description
DateRangePickerPropertiesBuilder

StartDate(DateTime)

Declaration

public DateRangePickerPropertiesBuilder StartDate(DateTime startDate)

Parameters

Type	Name	Description
System.DateTime	startDate

Returns

Type	Description
DateRangePickerPropertiesBuilder

StartDate(String)

Specifies the starting date of date ranges in the calendar with the specified string argument.

Declaration

public DateRangePickerPropertiesBuilder StartDate(string startDate)

Parameters

Type	Name	Description
System.String	startDate

Returns

Type	Description
DateRangePickerPropertiesBuilder

TimeFormat(String)

Specifies to time format to be displayed on time picker input field with DateRangPicker input field .

Declaration

public DateRangePickerPropertiesBuilder TimeFormat(string timeFormat)

Parameters

Type	Name	Description
System.String	timeFormat

Returns

Type	Description
DateRangePickerPropertiesBuilder

ToHtmlString()

Represents an HTML-encoded string.

Declaration

public string ToHtmlString()

Returns

Type	Description
System.String

Value(String)

Specifies the value of date range picker with the specified string(only string type).

Declaration

public DateRangePickerPropertiesBuilder Value(string value)

Parameters

Type	Name	Description
System.String	value

Returns

Type	Description
DateRangePickerPropertiesBuilder

WatermarkText(String)

Specifies the place holder value for DateRangePicker input field.

Declaration

public DateRangePickerPropertiesBuilder WatermarkText(string watermarkText)

Parameters

Type	Name	Description
System.String	watermarkText

Returns

Type	Description
DateRangePickerPropertiesBuilder

Width(String)

Specifies the width of the DateTimePicker input field.

Declaration

public DateRangePickerPropertiesBuilder Width(string width)

Parameters

Type	Name	Description
System.String	width

Returns

Type	Description
DateRangePickerPropertiesBuilder

Implements

IPropertiesBuilder

System.Web.IHtmlString