CalendarBuilder Class

Defines a builder to configurate Calendar.

Inheritance

object

HideObjectMembers

BaseBuilder<Calendar, CalendarBuilder>

ComponentBuilder<Calendar, CalendarBuilder>

ControlBuilder<Calendar, CalendarBuilder>

InputBaseBuilder<Calendar, CalendarBuilder>

CalendarBuilder

Implements

IHtmlContent

Namespace: C1.Web.Mvc.Fluent

Assembly: C1.AspNetCore.Mvc.dll

Syntax

public class CalendarBuilder : InputBaseBuilder<Calendar, CalendarBuilder>, IHtmlContent

Public Class CalendarBuilder
    Inherits InputBaseBuilder(Of Calendar, CalendarBuilder)
    Implements IHtmlContent

Constructors

Name	Description
CalendarBuilder(Calendar)	Creates one CalendarBuilder instance to configurate `component`.

Methods

Name	Description
AriaLabel(string)	Configurates AriaLabel. Sets the aria-label attribute of "Calendar" element.
DisplayMonth(DateTime)	Configurates DisplayMonth. Sets the month displayed in the calendar.
FirstDayOfWeek(DayOfWeek)	Configurates FirstDayOfWeek. Sets a value that represents the first day of the week, the one displayed in the first column of the calendar.
FocusMode(bool)	Configurates FocusMode. Sets the focusMode enabled to support wcag related functions of " Calendar" element.
FormatDayHeaders(string)	Configurates FormatDayHeaders. Sets the format used to display the headers above the days in month view.
FormatDays(string)	Configurates FormatDays. Sets the format used to display the days in month view.
FormatMonths(string)	Configurates FormatMonths. Sets the format used to display the months in year view.
FormatYear(string)	Configurates FormatYear. Sets the format used to display the year above the months in year view.
FormatYearMonth(string)	Configurates FormatYearMonth. Sets the format used to display the month and year above the calendar in month view.
HandleWheel(bool)	Configurates HandleWheel. Sets a value that determines whether the user can change the current displayMonth using the mouse wheel.
IsReadOnly(bool)	Configurates IsReadOnly. Sets a value that indicates whether the user can modify the control value using the mouse and keyboard.
ItemFormatter(string)	Configurates ItemFormatter. Sets a formatter function to customize dates in the calendar.
ItemValidator(string)	Configurates ItemValidator. Sets the name of a validator javascript function to determine whether dates are valid for selection.
KeyActionTab(CalendarTabKeyAction)	Configurates KeyActionTab. Sets the action to perform when the Tab key is pressed.
Max(DateTime)	Configurates Max. Sets the latest date that the user can select in the calendar.
Min(DateTime)	Configurates Min. Sets the earliest date that the user can select in the calendar.
MonthCount(int)	Configurates MonthCount. Sets the number of months to display within the calendar.
MonthView(bool)	Configurates MonthView. Sets a value indicating whether the calendar displays a month or a year.
OnClientDisplayMonthChanged(string)	Configurates the OnClientDisplayMonthChanged client event. Occurs after the DisplayMonth property changes.
OnClientFormatItem(string)	Configurates the OnClientFormatItem client event. Occurs when an element representing a day in the calendar has been created.
OnClientRangeChanged(string)	Configurates the OnClientRangeChanged client event. Occurs when the value of the rangeEnd property changes into a non-null value, indicating a data range has been selected.
OnClientRangeEndChanged(string)	Configurates the OnClientRangeEndChanged client event. Occurs when the value of the RangeEnd property changes
OnClientValueChanged(string)	Configurates the OnClientValueChanged client event. Occurs after a new date is selected.
RangeEnd(DateTime)	Configurates RangeEnd. Sets the last selected date in a range selection.
RangeMax(int)	Configurates RangeMax. Sets the maximum length allowed when editing date ranges.
RangeMin(int)	Configurates RangeMin. Sets the minimum number of days allowed when editing date ranges.
RepeatButtons(bool)	Configurates RepeatButtons. Sets a value that determines whether the calendar buttons should act as repeat buttons, firing repeatedly as the button remains pressed.
SelectionMode(DateSelectionMode)	Configurates SelectionMode. Sets a value that indicates whether users can select days, months, or no values at all.
ShowHeader(bool)	Configurates ShowHeader. Sets a value indicating whether the control displays the header area with the current month and navigation buttons.
ShowMonthPicker(ShowMonthPicker)	Configurates ShowMonthPicker. Sets a value that determines whether the calendar should display a list of months when the user clicks the header element on the month calendar.
ShowYearPicker(bool)	Configurates ShowYearPicker. Sets a value that determines whether the calendar should display a list of years when the user clicks the header element on the year calendar.
Value(DateTime)	Configurates Value. Sets the currently selected date.
WeeksAfter(int)	Configurates WeeksAfter. Sets the number of weeks to show on the calendar after the current month.
WeeksBefore(int)	Configurates WeeksBefore. Sets the number of weeks to show on the calendar before the current month.