Class Calendar

Inheritance
System.Object
TagHelper
EJTagHelper
Calendar
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.EJ2.Calendars
Assembly: Syncfusion.EJ2.dll
Syntax
public class Calendar : EJTagHelper

Constructors

Calendar()

Declaration
public Calendar()

Properties

CalendarMode

Gets or sets the Calendar's Type like gregorian or islamic.

Declaration
[HtmlAttributeName("calendarMode")]
public CalendarType CalendarMode { get; set; }
Property Value
Type Description
CalendarType

The default value is CalendarType.Gregorian

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

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

Specifies the root CSS class of the Calendar that allows to customize the appearance by overriding the styles.

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

The default value is null

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 such as month, year, and 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 or not.

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

The default value is true

EnablePersistence

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

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

FirstDayOfWeek

Gets or sets the Calendar's first day of the week. By default, the first day of the week will be based on the current culture.

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

The default value is 0

HtmlAttributes

Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.

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

IsMultiSelection

Specifies the option to enable the multiple dates selection of the calendar.

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

The default value is false

KeyConfigs

Customizes the key actions in Calendar. 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 ""

Max

Gets or sets the maximum date that can be selected in the Calendar.

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

The default value is null

Min

Gets or sets the minimum date that can be selected in the Calendar.

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

The default value is null

Navigated

Triggers when the Calendar is navigated to another level 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

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

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

ShowTodayButton

Specifies whether the today button is to be displayed or not.

Declaration
[HtmlAttributeName("showTodayButton")]
public bool ShowTodayButton { 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

Value

Gets or sets the selected date of the Calendar.

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

The default value is null

Values

Gets or sets multiple selected dates of the calendar. {% codeBlock src='calendar/values/index.md' %}{% endcodeBlock %}

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

The default value is null

WeekNumber

Determines whether the week number of the year is to be displayed in the calendar or not.

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