Blazor

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class CalendarBase<T> - Blazor API Reference | Syncfusion

    Show / Hide Table of Contents

    Class CalendarBase<T>

    The Calendar is a graphical user interface component that displays a Gregorian Calendar, and allows a user to select a date.

    Inheritance
    System.Object
    SfBaseComponent
    SfInputTextBase<T>
    CalendarBase<T>
    SfCalendar<TValue>
    SfDatePicker<TValue>
    SfDateRangePicker<TValue>
    Inherited Members
    SfInputTextBase<T>.CONTROL_CONTAINER
    SfInputTextBase<T>.CONTROL_OLD_CONTAINER
    SfInputTextBase<T>.INPUTGROUP
    SfInputTextBase<T>.CLEARICONHIDE
    SfInputTextBase<T>.MULTILINE
    SfInputTextBase<T>.DISABLE
    SfInputTextBase<T>.INPUT
    SfInputTextBase<T>.INPUTFOCUS
    SfInputTextBase<T>.FLOATINPUT
    SfInputTextBase<T>.FLOATTEXT
    SfInputTextBase<T>.FLOATLABELBOTTOM
    SfInputTextBase<T>.FLOATLABELTOP
    SfInputTextBase<T>.INCREMENT_TITLE
    SfInputTextBase<T>.DECREMENT_TITLE
    SfInputTextBase<T>.INCREMENT
    SfInputTextBase<T>.DECREMENT
    SfInputTextBase<T>.DISABLED_ATTR
    SfInputTextBase<T>.ARIA_DISABLED
    SfInputTextBase<T>.APPEND
    SfInputTextBase<T>.PREPEND
    SfInputTextBase<T>.CLEAR_ICON_HIDE
    SfInputTextBase<T>.GROUP_ICON
    SfInputTextBase<T>.SPACE
    SfInputTextBase<T>.SPIN_DOWN
    SfInputTextBase<T>.SPIN_UP
    SfInputTextBase<T>.DISABLE_ICON
    SfInputTextBase<T>.OnInitializedAsync()
    SfInputTextBase<T>.OnParametersSetAsync()
    SfInputTextBase<T>.OnAfterRenderAsync(Boolean)
    SfInputTextBase<T>.FormatValueAsString(T)
    SfInputTextBase<T>.FormatValue(String)
    SfInputTextBase<T>.InputHandler(ChangeEventArgs)
    SfInputTextBase<T>.OnInputHandler(ChangeEventArgs)
    SfInputTextBase<T>.OnPasteHandler(ClipboardEventArgs)
    SfInputTextBase<T>.FocusHandler(FocusEventArgs)
    Syncfusion.Blazor.Inputs.SfInputTextBase<T>.BlurHandler()
    SfInputTextBase<T>.FocusOutHandler(FocusEventArgs)
    SfInputTextBase<T>.ChangeHandler(ChangeEventArgs)
    SfInputTextBase<T>.OnChangeHandler(ChangeEventArgs)
    SfInputTextBase<T>.WireClearBtnEvents()
    Syncfusion.Blazor.Inputs.SfInputTextBase<T>.OnChange
    Syncfusion.Blazor.Inputs.SfInputTextBase<T>.OnInput
    Syncfusion.Blazor.Inputs.SfInputTextBase<T>.OnPaste
    Syncfusion.Blazor.Inputs.SfInputTextBase<T>.OnBlur
    Syncfusion.Blazor.Inputs.SfInputTextBase<T>.OnFocus
    SfInputTextBase<T>.ID
    SfInputTextBase<T>.Value
    SfInputTextBase<T>._value
    SfInputTextBase<T>.ValueChanged
    Syncfusion.Blazor.Inputs.SfInputTextBase<T>.ValueExpression
    SfInputTextBase<T>.InputEditContext
    SfInputTextBase<T>.CssClass
    SfInputTextBase<T>.EnablePersistence
    SfInputTextBase<T>.EnableRtl
    SfInputTextBase<T>.Enabled
    SfInputTextBase<T>.BaseFloatLabelType
    SfInputTextBase<T>.BaseHtmlAttributes
    SfInputTextBase<T>.BaseInputAttributes
    SfInputTextBase<T>.ValidateOnInput
    SfInputTextBase<T>.MultilineInput
    SfInputTextBase<T>.BasePlaceholder
    SfInputTextBase<T>.BaseReadonly
    SfInputTextBase<T>.BaseIsReadOnlyInput
    SfInputTextBase<T>.BaseShowClearButton
    SfInputTextBase<T>.BaseWidth
    SfInputTextBase<T>.BaseTabIndex
    SfInputTextBase<T>.BaseAutocomplete
    SfInputTextBase<T>.ContainerAttr
    Syncfusion.Blazor.Inputs.SfInputTextBase<T>.SpinButton
    Syncfusion.Blazor.Inputs.SfInputTextBase<T>.ValueTemplate
    Syncfusion.Blazor.Inputs.SfInputTextBase<T>.IsValueTemplate
    Syncfusion.Blazor.Inputs.SfInputTextBase<T>.ClickStopPropagation
    Syncfusion.Blazor.Inputs.SfInputTextBase<T>.MouseDowSpinnerPrevent
    Syncfusion.Blazor.Inputs.SfInputTextBase<T>.PreventIconHandler
    Syncfusion.Blazor.Inputs.SfInputTextBase<T>.MousePreventContainer
    SfInputTextBase<T>.ListOfButtons
    SfInputTextBase<T>.DataId
    SfInputTextBase<T>.inputAttr
    SfInputTextBase<T>.containerAttributes
    SfInputTextBase<T>.FloatLabel
    SfInputTextBase<T>.ClearElement
    SfInputTextBase<T>.IsFocused
    SfInputTextBase<T>.IncrementTitle
    SfInputTextBase<T>.DecrementTitle
    Syncfusion.Blazor.Inputs.SfInputTextBase<T>.ContainerClass
    Syncfusion.Blazor.Inputs.SfInputTextBase<T>.RootClass
    SfInputTextBase<T>.ComponentReference
    SfBaseComponent.Dispose()
    SfBaseComponent.Dispose(Boolean)
    SfBaseComponent.OnObservableChange(String, Object, Boolean, NotifyCollectionChangedEventArgs)
    Namespace: Syncfusion.Blazor.Calendars
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class CalendarBase<T> : SfInputTextBase<T>
    Type Parameters
    Name Description
    T

    Specifies the type of CalendarBase.

    Constructors

    CalendarBase()

    Declaration
    public CalendarBase()

    Properties

    CalendarEditContext

    Specifies the editcontext of the Calendar.

    Declaration
    protected EditContext CalendarEditContext { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.Forms.EditContext

    CalendarMode

    Sets the calendar's type like Gregorian.

    Declaration
    public CalendarType CalendarMode { get; set; }
    Property Value
    Type Description
    CalendarType

    DayHeaderFormat

    Specifies the format of the day that to be displayed in the header. By default, the format is short.

    Possible formats are:

    • ShortSets the short format of day name (like Su ) in day header.
    • NarrowSets the single character of day name (like S ) in day header.
    • AbbreviatedSets the min format of day name (like Sun ) in day header.
    • WideSets the long format of day name (like Sunday ) in day header.
    Declaration
    public DayHeaderFormats DayHeaderFormat { get; set; }
    Property Value
    Type Description
    DayHeaderFormats

    Depth

    Sets the maximum level of views such as a month, year, and decade in the calendar.

    The depth view should be smaller than the start view to restrict its view navigation.

    Declaration
    public CalendarView Depth { get; set; }
    Property Value
    Type Description
    CalendarView

    FirstDayOfWeek

    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
    public int FirstDayOfWeek { get; set; }
    Property Value
    Type Description
    System.Int32

    KeyConfigs

    Customizes the key actions in the calendar.

    For example, when using a German keyboard, the key actions can be customized using these shortcuts.

    Declaration
    public Dictionary<string, object> KeyConfigs { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.Dictionary<System.String, System.Object>

    Max

    Specifies a maximum date that is allowed a user can select in the calendar.

    Declaration
    public virtual DateTime Max { get; set; }
    Property Value
    Type Description
    System.DateTime

    Min

    Specifies a minimum date that is allowed a user can select in the calendar.

    Declaration
    public virtual DateTime Min { get; set; }
    Property Value
    Type Description
    System.DateTime

    ServerTimezoneOffset

    By default, the date value will be processed based on the system time zone.

    If you want to process the initial date value using the server time zone then specify the time zone value to the ServerTimezoneOffset property.

    Declaration
    public double ServerTimezoneOffset { get; set; }
    Property Value
    Type Description
    System.Double

    ShowTodayButton

    Specifies whether the today button will be displayed in the calendar.

    Declaration
    public bool ShowTodayButton { get; set; }
    Property Value
    Type Description
    System.Boolean

    Start

    Specifies the initial view of the calendar when it is opened. With the help of this property, the initial view can be changed to the year or decade view.

    Declaration
    public CalendarView Start { get; set; }
    Property Value
    Type Description
    CalendarView

    WeekNumber

    Specifies whether the week number of the year will be displayed in the calendar.

    Declaration
    public bool WeekNumber { get; set; }
    Property Value
    Type Description
    System.Boolean

    WeekRule

    Specifies the rule for defining the first week of the year.

    Declaration
    public CalendarWeekRule WeekRule { get; set; }
    Property Value
    Type Description
    System.Globalization.CalendarWeekRule

    Methods

    ChangeEvent(EventArgs)

    Triggers when the value get changed.

    Declaration
    protected virtual void ChangeEvent(EventArgs args)
    Parameters
    Type Name Description
    System.EventArgs args

    Specifies the System.EventArgs.

    Back to top Generated by DocFX
    Copyright © 2001 - 2022 Syncfusion Inc. All Rights Reserved