Class DatePickerPropertiesBuilder

Inheritance

System.Object

DatePickerPropertiesBuilder

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 DatePickerPropertiesBuilder : IPropertiesBuilder, IHtmlString

Constructors

DatePickerPropertiesBuilder()

Initializes a new instance of the DatePickerPropertiesBuilder class.

Declaration

public DatePickerPropertiesBuilder()

DatePickerPropertiesBuilder(DatePicker)

Initializes a new instance of the DatePickerPropertiesBuilder class by the specified date picker object.

Declaration

public DatePickerPropertiesBuilder(DatePicker datePicker)

Parameters

Type	Name	Description
DatePicker	datePicker

Fields

datePicker

Specifies the instance of the DatePicker class.

Declaration

public DatePicker datePicker

Field Value

Type	Description
DatePicker

Properties

Items

Specifies the collection of dates as special dates.

Declaration

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

Property Value

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

Methods

AllowDrillDown()

Allows drilldown to multiple levels of view (month/year/decade) in date picker calendar.

Declaration

public DatePickerPropertiesBuilder AllowDrillDown()

Returns

Type	Description
DatePickerPropertiesBuilder

AllowDrillDown(Boolean)

Allows or restricts drilldown to multiple levels of view (month/year/decade) in datepicker calendar based on the specified boolean argument.

Declaration

public DatePickerPropertiesBuilder AllowDrillDown(bool allowDrillDown)

Parameters

Type	Name	Description
System.Boolean	allowDrillDown

Returns

Type	Description
DatePickerPropertiesBuilder

AllowEdit()

Specifies to edit the date values in the input field of the date picker.

Declaration

public DatePickerPropertiesBuilder AllowEdit()

Returns

Type	Description
DatePickerPropertiesBuilder

AllowEdit(Boolean)

Specifies to edit the date values in the input field of the date picker based on the boolean argument specified.

Declaration

public DatePickerPropertiesBuilder AllowEdit(bool allowEdit)

Parameters

Type	Name	Description
System.Boolean	allowEdit

Returns

Type	Description
DatePickerPropertiesBuilder

BlackoutDates(List<Object>)

Specifies the blackout dates of Calendar.

Declaration

public DatePickerPropertiesBuilder BlackoutDates(List<object> blackoutDates)

Parameters

Type	Name	Description
System.Collections.Generic.List<System.Object>	blackoutDates

Returns

Type	Description
DatePickerPropertiesBuilder

ButtonText(String)

Specifies the text to be displayed in 'Today' button of date picker calendar.

Declaration

public DatePickerPropertiesBuilder ButtonText(string buttonText)

Parameters

Type	Name	Description
System.String	buttonText

Returns

Type	Description
DatePickerPropertiesBuilder

ClientSideEvents(Action<DatePickerClientSideEventsBuilder>)

Specifies to trigger the date picker client side events.

Declaration

public DatePickerPropertiesBuilder ClientSideEvents(Action<DatePickerClientSideEventsBuilder> clientSideEvents)

Parameters

Type	Name	Description
System.Action<DatePickerClientSideEventsBuilder>	clientSideEvents

Returns

Type	Description
DatePickerPropertiesBuilder

CssClass(String)

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

Declaration

public DatePickerPropertiesBuilder CssClass(string cssClass)

Parameters

Type	Name	Description
System.String	cssClass

Returns

Type	Description
DatePickerPropertiesBuilder

DateFormat(String)

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

Declaration

public DatePickerPropertiesBuilder DateFormat(string dateFormat)

Parameters

Type	Name	Description
System.String	dateFormat

Returns

Type	Description
DatePickerPropertiesBuilder

DayHeaderFormat(Header)

Specifies the days header format in date picker calendar.

Declaration

public DatePickerPropertiesBuilder DayHeaderFormat(Header dayHeaderFormat)

Parameters

Type	Name	Description
Header	dayHeaderFormat

Returns

Type	Description
DatePickerPropertiesBuilder

DepthLevel(Period)

Specifies the navigation depth level in date picker calendar. This is applicable when start level view is lower than depth level view.

Declaration

public DatePickerPropertiesBuilder DepthLevel(Period depthLevel)

Parameters

Type	Name	Description
Period	depthLevel

Returns

Type	Description
DatePickerPropertiesBuilder

DisplayInline()

Specifies to display the date picker popup always in visible state.

Declaration

public DatePickerPropertiesBuilder DisplayInline()

Returns

Type	Description
DatePickerPropertiesBuilder

DisplayInline(Boolean)

Specifies to display the date picker popup always in visible state with specified argument.

Declaration

public DatePickerPropertiesBuilder DisplayInline(bool displayInline)

Parameters

Type	Name	Description
System.Boolean	displayInline

Returns

Type	Description
DatePickerPropertiesBuilder

EnableAnimation()

Specifies the animation effect when date picker popup opens/closes.

Declaration

public DatePickerPropertiesBuilder EnableAnimation()

Returns

Type	Description
DatePickerPropertiesBuilder

EnableAnimation(Boolean)

Specifies the animation effect when date picker popup opens/closes based on the specified boolean argument.

Declaration

public DatePickerPropertiesBuilder EnableAnimation(bool enableAnimation)

Parameters

Type	Name	Description
System.Boolean	enableAnimation

Returns

Type	Description
DatePickerPropertiesBuilder

Enabled()

Allows the date picker control to respond for user interaction.

Declaration

public DatePickerPropertiesBuilder Enabled()

Returns

Type	Description
DatePickerPropertiesBuilder

Enabled(Boolean)

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

Declaration

public DatePickerPropertiesBuilder Enabled(bool enabled)

Parameters

Type	Name	Description
System.Boolean	enabled

Returns

Type	Description
DatePickerPropertiesBuilder

EnablePersistence()

Persists date picker model even after form post back or browser refresh.

Declaration

public DatePickerPropertiesBuilder EnablePersistence()

Returns

Type	Description
DatePickerPropertiesBuilder

EnablePersistence(Boolean)

Persists date picker model even after form post back or browser refresh with the specified argument.

Declaration

public DatePickerPropertiesBuilder EnablePersistence(bool enablePersistence)

Parameters

Type	Name	Description
System.Boolean	enablePersistence

Returns

Type	Description
DatePickerPropertiesBuilder

EnableRTL()

Specifies to align the input field and calender in right to left direction.

Declaration

public DatePickerPropertiesBuilder EnableRTL()

Returns

Type	Description
DatePickerPropertiesBuilder

EnableRTL(Boolean)

Specifies to align the input field and calender in right to left direction with the specified argument.

Declaration

public DatePickerPropertiesBuilder EnableRTL(bool enableRTL)

Parameters

Type	Name	Description
System.Boolean	enableRTL

Returns

Type	Description
DatePickerPropertiesBuilder

EnableStrictMode()

Date picker input field accepts the invalid date and out of range date.

Declaration

public DatePickerPropertiesBuilder EnableStrictMode()

Returns

Type	Description
DatePickerPropertiesBuilder

EnableStrictMode(Boolean)

Date picker input field accepts the invalid date and out of range date based on the specified boolean argument.

Declaration

public DatePickerPropertiesBuilder EnableStrictMode(bool strictMode)

Parameters

Type	Name	Description
System.Boolean	strictMode

Returns

Type	Description
DatePickerPropertiesBuilder

HeaderFormat(String)

Specifies the header format to be displayed in the date picker calendar.

Declaration

public DatePickerPropertiesBuilder HeaderFormat(string headerFormat)

Parameters

Type	Name	Description
System.String	headerFormat

Returns

Type	Description
DatePickerPropertiesBuilder

Height(String)

Sets the height of the date picker input field.

Declaration

public DatePickerPropertiesBuilder Height(string height)

Parameters

Type	Name	Description
System.String	height

Returns

Type	Description
DatePickerPropertiesBuilder

HighlightSection(Section)

Highlights the month/week/workdays of currently selected date.

Declaration

public DatePickerPropertiesBuilder HighlightSection(Section highLightSection)

Parameters

Type	Name	Description
Section	highLightSection

Returns

Type	Description
DatePickerPropertiesBuilder

HighlightWeekend()

Highlights weekend dates.

Declaration

public DatePickerPropertiesBuilder HighlightWeekend()

Returns

Type	Description
DatePickerPropertiesBuilder

HighlightWeekend(Boolean)

Highlights weekend dates with the specified argument.

Declaration

public DatePickerPropertiesBuilder HighlightWeekend(bool highlightWeekend)

Parameters

Type	Name	Description
System.Boolean	highlightWeekend

Returns

Type	Description
DatePickerPropertiesBuilder

HtmlAttributes(IDictionary<String, Object>)

Specifies to map the field of html attributes.

Declaration

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

Parameters

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

Returns

Type	Description
DatePickerPropertiesBuilder

Locale(String)

Localize the date picker calendar to the specified language.

Declaration

public DatePickerPropertiesBuilder Locale(string locale)

Parameters

Type	Name	Description
System.String	locale

Returns

Type	Description
DatePickerPropertiesBuilder

MaxDate(DateTime)

Specifies the maximum date in the calendar with the specified DateTime argument.

Declaration

public DatePickerPropertiesBuilder MaxDate(DateTime maxDate)

Parameters

Type	Name	Description
System.DateTime	maxDate

Returns

Type	Description
DatePickerPropertiesBuilder

MaxDate(String)

Sets the maximum date in the calendar with the specified string argument.

Declaration

public DatePickerPropertiesBuilder MaxDate(string maxDate)

Parameters

Type	Name	Description
System.String	maxDate

Returns

Type	Description
DatePickerPropertiesBuilder

MinDate(DateTime)

Specifies the minimum date in the calendar with the specified DateTime argument.

Declaration

public DatePickerPropertiesBuilder MinDate(DateTime minDate)

Parameters

Type	Name	Description
System.DateTime	minDate

Returns

Type	Description
DatePickerPropertiesBuilder

MinDate(String)

Specifies the minimum date in the calendar with the specified string argument.

Declaration

public DatePickerPropertiesBuilder MinDate(string minDate)

Parameters

Type	Name	Description
System.String	minDate

Returns

Type	Description
DatePickerPropertiesBuilder

ReadOnly()

Restricts to pick the date from the calender and edit the date in the input field.

Declaration

public DatePickerPropertiesBuilder ReadOnly()

Returns

Type	Description
DatePickerPropertiesBuilder

ReadOnly(Boolean)

Restricts to pick the date from the calender and edit the date in the input field with the specified argument.

Declaration

public DatePickerPropertiesBuilder ReadOnly(bool readOnly)

Parameters

Type	Name	Description
System.Boolean	readOnly

Returns

Type	Description
DatePickerPropertiesBuilder

Render()

Renders the date picker instance.

Declaration

public void Render()

ShowDisabledRange()

Shows the disabled dates.

Declaration

public DatePickerPropertiesBuilder ShowDisabledRange()

Returns

Type	Description
DatePickerPropertiesBuilder

ShowDisabledRange(Boolean)

Shows the disabled dates based on the boolean argument specified.

Declaration

public DatePickerPropertiesBuilder ShowDisabledRange(bool showDisabledRange)

Parameters

Type	Name	Description
System.Boolean	showDisabledRange

Returns

Type	Description
DatePickerPropertiesBuilder

ShowFooter()

Specifies to display the footer in the calendar.

Declaration

public DatePickerPropertiesBuilder ShowFooter()

Returns

Type	Description
DatePickerPropertiesBuilder

ShowFooter(Boolean)

Specifies to display the footer in the calendar based on the specifed boolean argument.

Declaration

public DatePickerPropertiesBuilder ShowFooter(bool showFooter)

Parameters

Type	Name	Description
System.Boolean	showFooter

Returns

Type	Description
DatePickerPropertiesBuilder

ShowOtherMonths()

Shows the days of adjacent months in the current month calendar.

Declaration

public DatePickerPropertiesBuilder ShowOtherMonths()

Returns

Type	Description
DatePickerPropertiesBuilder

ShowOtherMonths(Boolean)

Shows the days of adjacent months in the current month calendar with the specified argument.

Declaration

public DatePickerPropertiesBuilder ShowOtherMonths(bool showOtherMonths)

Parameters

Type	Name	Description
System.Boolean	showOtherMonths

Returns

Type	Description
DatePickerPropertiesBuilder

ShowPopupButton()

Shows or hides the date icon button in the textbox.

Declaration

public DatePickerPropertiesBuilder ShowPopupButton()

Returns

Type	Description
DatePickerPropertiesBuilder

ShowPopupButton(Boolean)

Shows or hides the date icon button in the textbox with the specified argument.

Declaration

public DatePickerPropertiesBuilder ShowPopupButton(bool showPopupButton)

Parameters

Type	Name	Description
System.Boolean	showPopupButton

Returns

Type	Description
DatePickerPropertiesBuilder

ShowRoundedCorner()

Displays the date picker with rounded corners.

Declaration

public DatePickerPropertiesBuilder ShowRoundedCorner()

Returns

Type	Description
DatePickerPropertiesBuilder

ShowRoundedCorner(Boolean)

Displays the date picker with rounded corners with the specified boolean argument.

Declaration

public DatePickerPropertiesBuilder ShowRoundedCorner(bool showRoundedCorner)

Parameters

Type	Name	Description
System.Boolean	showRoundedCorner

Returns

Type	Description
DatePickerPropertiesBuilder

ShowTooltip()

Shows tooltip when hovering the days in the calendar.

Declaration

public DatePickerPropertiesBuilder ShowTooltip()

Returns

Type	Description
DatePickerPropertiesBuilder

ShowTooltip(Boolean)

Shows tooltip when hovering the days in the calendar with the specified argument.

Declaration

public DatePickerPropertiesBuilder ShowTooltip(bool showTooltip)

Parameters

Type	Name	Description
System.Boolean	showTooltip

Returns

Type	Description
DatePickerPropertiesBuilder

SpecialDates(Action<SpecialDatesAdder>)

Specifies the special dates in the date picker calendar.

Declaration

public DatePickerPropertiesBuilder SpecialDates(Action<SpecialDatesAdder> fields)

Parameters

Type	Name	Description
System.Action<SpecialDatesAdder>	fields

Returns

Type	Description
DatePickerPropertiesBuilder

StartDay(Int32)

Specifies the start day of the week in the date picker calendar.

Declaration

public DatePickerPropertiesBuilder StartDay(int startDay)

Parameters

Type	Name	Description
System.Int32	startDay

Returns

Type	Description
DatePickerPropertiesBuilder

StartLevel(Period)

Specifies the start level view in date picker calendar.

Declaration

public DatePickerPropertiesBuilder StartLevel(Period startLevel)

Parameters

Type	Name	Description
Period	startLevel

Returns

Type	Description
DatePickerPropertiesBuilder

StepMonths(Int32)

Specifies the number of months to navigate for one click of next and previous buttons in date picker calendar.

Declaration

public DatePickerPropertiesBuilder StepMonths(int stepMonths)

Parameters

Type	Name	Description
System.Int32	stepMonths

Returns

Type	Description
DatePickerPropertiesBuilder

TagName(String)

Specifies the tag name 'div' to display the calendar in always visible mode without input field. This depends on boolean value of "DisplayInline".

Declaration

public DatePickerPropertiesBuilder TagName(string tagName)

Parameters

Type	Name	Description
System.String	tagName

Returns

Type	Description
DatePickerPropertiesBuilder

TimeZone()

Allows to set the value of the DatePicker based on the timezone.

Declaration

public DatePickerPropertiesBuilder TimeZone()

Returns

Type	Description
DatePickerPropertiesBuilder

TimeZone(Boolean)

Allows to set the value in datepicker based on the timezone.

Declaration

public DatePickerPropertiesBuilder TimeZone(bool timeZone)

Parameters

Type	Name	Description
System.Boolean	timeZone

Returns

Type	Description
DatePickerPropertiesBuilder

ToHtmlString()

Represents an HTML-encoded string.

Declaration

public string ToHtmlString()

Returns

Type	Description
System.String

TooltipFormat(String)

Specifies the tooltip text format when hover the days in the calendar.

Declaration

public DatePickerPropertiesBuilder TooltipFormat(string tooltipFormat)

Parameters

Type	Name	Description
System.String	tooltipFormat

Returns

Type	Description
DatePickerPropertiesBuilder

ValidationMessage(Action<DatePickerPropertiesBuilder.DatePickerValidationMessageBuilder>)

Declaration

[Obsolete("The ValidationMessage property has been deprecated.Use 'ValidationMessages' instead")]
public DatePickerPropertiesBuilder ValidationMessage(Action<DatePickerPropertiesBuilder.DatePickerValidationMessageBuilder> validationMessage)

Parameters

Type	Name	Description
System.Action<DatePickerPropertiesBuilder.DatePickerValidationMessageBuilder>	validationMessage

Returns

Type	Description
DatePickerPropertiesBuilder

ValidationMessage(Dictionary<String, Object>)

Sets jQuery validation messages for DatePicker input. This API is deprecated, please use ValidationMessages instead of this.

Declaration

[Obsolete("The ValidationMessage property has been deprecated.Use 'ValidationMessages' instead")]
public DatePickerPropertiesBuilder ValidationMessage(Dictionary<string, object> validationMessage)

Parameters

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

Returns

Type	Description
DatePickerPropertiesBuilder

ValidationMessages(Action<DatePickerPropertiesBuilder.DatePickerValidationMessageBuilder>)

Sets jQuery validation messages for DatePicker input.

Declaration

public DatePickerPropertiesBuilder ValidationMessages(Action<DatePickerPropertiesBuilder.DatePickerValidationMessageBuilder> validationMessage)

Parameters

Type	Name	Description
System.Action<DatePickerPropertiesBuilder.DatePickerValidationMessageBuilder>	validationMessage

Returns

Type	Description
DatePickerPropertiesBuilder

ValidationMessages(Dictionary<String, Object>)

Sets jQuery validation messages for DatePicker input.

Declaration

public DatePickerPropertiesBuilder ValidationMessages(Dictionary<string, object> validationMessage)

Parameters

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

Returns

Type	Description
DatePickerPropertiesBuilder

ValidationRules(Action<DatePickerPropertiesBuilder.DatePickerValidationRuleBuilder>)

Sets jQuery validation custom rules for DatePicker input.

Declaration

public DatePickerPropertiesBuilder ValidationRules(Action<DatePickerPropertiesBuilder.DatePickerValidationRuleBuilder> validationRule)

Parameters

Type	Name	Description
System.Action<DatePickerPropertiesBuilder.DatePickerValidationRuleBuilder>	validationRule

Returns

Type	Description
DatePickerPropertiesBuilder

ValidationRules(Dictionary<String, Object>)

Sets jQuery validation messages for DatePicker input.

Declaration

public DatePickerPropertiesBuilder ValidationRules(Dictionary<string, object> validationRule)

Parameters

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

Returns

Type	Description
DatePickerPropertiesBuilder

Value(DateTime)

Specifies the value of date picker.

Declaration

public DatePickerPropertiesBuilder Value(DateTime value)

Parameters

Type	Name	Description
System.DateTime	value

Returns

Type	Description
DatePickerPropertiesBuilder

Value(String)

Specifies the value of date picker with the specified string.

Declaration

public DatePickerPropertiesBuilder Value(string value)

Parameters

Type	Name	Description
System.String	value

Returns

Type	Description
DatePickerPropertiesBuilder

WatermarkText(String)

Specifies watermark text to be displayed in input field.

Declaration

public DatePickerPropertiesBuilder WatermarkText(string watermarkText)

Parameters

Type	Name	Description
System.String	watermarkText

Returns

Type	Description
DatePickerPropertiesBuilder

WeekNumber(Boolean)

Allows to show weekNumber of every week in extra column in the date picker popup.

Declaration

public DatePickerPropertiesBuilder WeekNumber(bool weekNumber)

Parameters

Type	Name	Description
System.Boolean	weekNumber

Returns

Type	Description
DatePickerPropertiesBuilder

Width(String)

Sets the width of the date picker input field.

Declaration

public DatePickerPropertiesBuilder Width(string width)

Parameters

Type	Name	Description
System.String	width

Returns

Type	Description
DatePickerPropertiesBuilder

Implements

IPropertiesBuilder

System.Web.IHtmlString