menu

Blazor

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class SfDateTimePicker<TValue> - Blazor API Reference | Syncfusion

    Show / Hide Table of Contents

    Class SfDateTimePicker<TValue>

    The DateTimePicker is a graphical user interface component that allows the user to select or enter a date value.

    Inheritance
    System.Object
    SfBaseComponent
    SfInputTextBase<TValue>
    CalendarBase<TValue>
    SfDatePicker<TValue>
    SfDateTimePicker<TValue>
    Inherited Members
    CalendarBase<TValue>.CalendarEditContext
    CalendarBase<TValue>.CalendarMode
    CalendarBase<TValue>.ConvertDateValue(TValue)
    CalendarBase<TValue>.ConvertToGregorian(String, String)
    CalendarBase<TValue>.ConvertToHijri(TValue, String)
    CalendarBase<TValue>.DayHeaderFormat
    CalendarBase<TValue>.Depth
    CalendarBase<TValue>.FirstDayOfWeek
    CalendarBase<TValue>.GetHijriMonthIndex(String, String)
    CalendarBase<TValue>.KeyConfigs
    CalendarBase<TValue>.ReplaceMonthName(String, DateTime, String[], String)
    CalendarBase<TValue>.ServerTimezoneOffset
    CalendarBase<TValue>.ShowTodayButton
    CalendarBase<TValue>.Start
    CalendarBase<TValue>.WeekNumber
    CalendarBase<TValue>.WeekRule
    SfBaseComponent.Dispose()
    SfBaseComponent.Dispose(Boolean)
    SfBaseComponent.OnObservableChange(String, Object, Boolean, NotifyCollectionChangedEventArgs)
    SfDatePicker<TValue>.AllowEdit
    SfDatePicker<TValue>.ARIA_ACTIVE_DESCENDANT
    SfDatePicker<TValue>.ARIA_INVALID
    SfDatePicker<TValue>.BaseFloatLabelType
    SfDatePicker<TValue>.BaseHtmlAttributes
    SfDatePicker<TValue>.BaseInputAttributes
    SfDatePicker<TValue>.BaseIsReadOnlyInput
    SfDatePicker<TValue>.BasePlaceholder
    SfDatePicker<TValue>.BaseReadonly
    SfDatePicker<TValue>.BaseShowClearButton
    SfDatePicker<TValue>.BaseTabIndex
    SfDatePicker<TValue>.BaseWidth
    SfDatePicker<TValue>.ClientPopupRender()
    SfDatePicker<TValue>.CreateMask()
    SfDatePicker<TValue>.CurrentView()
    SfDatePicker<TValue>.DATE_ICON
    SfDatePicker<TValue>.EnableMask
    SfDatePicker<TValue>.ERROR_CLASS
    SfDatePicker<TValue>.FALSE
    SfDatePicker<TValue>.FloatLabelType
    SfDatePicker<TValue>.FocusAsync()
    SfDatePicker<TValue>.FocusOutAsync()
    SfDatePicker<TValue>.Format
    SfDatePicker<TValue>.FormatValue(String)
    SfDatePicker<TValue>.FormatValueAsString(TValue)
    SfDatePicker<TValue>.FullScreen
    SfDatePicker<TValue>.GetDefaultFormat()
    SfDatePicker<TValue>.GetPersistDataAsync()
    SfDatePicker<TValue>.HidePopupAsync(EventArgs)
    SfDatePicker<TValue>.HtmlAttributes
    SfDatePicker<TValue>.InputAttributes
    SfDatePicker<TValue>.InputFormats
    SfDatePicker<TValue>.InputHandler(ChangeEventArgs)
    SfDatePicker<TValue>.InvokeClearBtnEvent(EventArgs)
    SfDatePicker<TValue>.NavigateAsync(CalendarView, TValue)
    SfDatePicker<TValue>.OpenOnFocus
    SfDatePicker<TValue>.Placeholder
    SfDatePicker<TValue>.Readonly
    SfDatePicker<TValue>.ShowClearButton
    SfDatePicker<TValue>.ShowPopup(EventArgs)
    SfDatePicker<TValue>.ShowPopupAsync(EventArgs)
    SfDatePicker<TValue>.StrictMode
    SfDatePicker<TValue>.TabIndex
    SfDatePicker<TValue>.TimePart
    SfDatePicker<TValue>.UpdateDateTimePopupState(Boolean)
    SfDatePicker<TValue>.UpdateValidateClass()
    SfDatePicker<TValue>.Width
    SfDatePicker<TValue>.ZIndex
    SfInputTextBase<TValue>._value
    SfInputTextBase<TValue>.APPEND
    SfInputTextBase<TValue>.APPEND_ICON
    SfInputTextBase<TValue>.ARIA_DISABLED
    SfInputTextBase<TValue>.BaseAutocomplete
    SfInputTextBase<TValue>.CLEAR_ICON_HIDE
    SfInputTextBase<TValue>.ClearElement
    SfInputTextBase<TValue>.CLEARICONHIDE
    SfInputTextBase<TValue>.ComponentReference
    SfInputTextBase<TValue>.ContainerAttr
    SfInputTextBase<TValue>.containerAttributes
    SfInputTextBase<TValue>.CONTROL_CONTAINER
    SfInputTextBase<TValue>.CONTROL_OLD_CONTAINER
    SfInputTextBase<TValue>.CssClass
    SfInputTextBase<TValue>.DataId
    SfInputTextBase<TValue>.DECREMENT
    SfInputTextBase<TValue>.DECREMENT_TITLE
    SfInputTextBase<TValue>.DecrementTitle
    SfInputTextBase<TValue>.DISABLE
    SfInputTextBase<TValue>.DISABLE_ICON
    SfInputTextBase<TValue>.DISABLED_ATTR
    SfInputTextBase<TValue>.Enabled
    SfInputTextBase<TValue>.EnablePersistence
    SfInputTextBase<TValue>.EnableRtl
    SfInputTextBase<TValue>.FLOATINPUT
    SfInputTextBase<TValue>.FloatLabel
    SfInputTextBase<TValue>.FLOATLABELBOTTOM
    SfInputTextBase<TValue>.FLOATLABELTOP
    SfInputTextBase<TValue>.FLOATTEXT
    SfInputTextBase<TValue>.GROUP_ICON
    SfInputTextBase<TValue>.ID
    SfInputTextBase<TValue>.INCREMENT
    SfInputTextBase<TValue>.INCREMENT_TITLE
    SfInputTextBase<TValue>.IncrementTitle
    SfInputTextBase<TValue>.INPUT
    SfInputTextBase<TValue>.inputAttr
    SfInputTextBase<TValue>.InputEditContext
    SfInputTextBase<TValue>.INPUTFOCUS
    SfInputTextBase<TValue>.INPUTGROUP
    SfInputTextBase<TValue>.IsClearButtonClicked
    SfInputTextBase<TValue>.IsFocused
    SfInputTextBase<TValue>.ListOfButtons
    SfInputTextBase<TValue>.MULTILINE
    SfInputTextBase<TValue>.MultilineInput
    SfInputTextBase<TValue>.OnChangeHandler(ChangeEventArgs)
    SfInputTextBase<TValue>.OnInputHandler(ChangeEventArgs)
    SfInputTextBase<TValue>.OnPasteHandler(ClipboardEventArgs)
    SfInputTextBase<TValue>.PREPEND
    SfInputTextBase<TValue>.PREPEND_ICON
    SfInputTextBase<TValue>.SetEnabled()
    SfInputTextBase<TValue>.SPACE
    SfInputTextBase<TValue>.SPIN_DOWN
    SfInputTextBase<TValue>.SPIN_UP
    SfInputTextBase<TValue>.ValidateOnInput
    SfInputTextBase<TValue>.Value
    SfInputTextBase<TValue>.ValueChanged
    SfInputTextBase<TValue>.WireClearBtnEvents()
    Syncfusion.Blazor.Calendars.CalendarBase<TValue>.CurrentCulture
    Syncfusion.Blazor.Calendars.CalendarBase<TValue>.IsDateOnlyType()
    Syncfusion.Blazor.Calendars.CalendarBase<TValue>.IsDateTimeOffsetType()
    Syncfusion.Blazor.Calendars.CalendarBase<TValue>.SetParametersAsync(Microsoft.AspNetCore.Components.ParameterView)
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.ACTIVE
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.ARIA_EXPANDED
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.BODY
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.CALENDAR_CELL_CONTAINER
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.CalendarBaseInstance
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.CalendarClass
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.ChangedEventArgs
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.ChangeEvent(System.EventArgs, System.Boolean)
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.ChangeHandler(Microsoft.AspNetCore.Components.ChangeEventArgs)
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.ChildContent
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.CLOSE_ICON
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.CloseIconClass
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.ClosePopup()
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.CONTAINER_CLASS
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.ConvertGeneric(System.DateTime)
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.DATE_CONTAINER
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.DATE_PICKER
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.DateIcon
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.DateIconHandler()
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.DatePickerParent
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.DAY_LOCALE_KEY
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.DAY_LOCALE_VALUE
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.DAYOFWEEK_LOCALE_KEY
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.DAYOFWEEK_LOCALE_VALUE
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.FocusHandler(Microsoft.AspNetCore.Components.Web.FocusEventArgs)
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.FocusOutHandler(Microsoft.AspNetCore.Components.Web.FocusEventArgs)
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.GetClientProperties()
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.GetDefaultCulture()
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.HidePopup(System.EventArgs)
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.HideTimePopup()
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.HOUR_LOCALE_KEY
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.HOUR_LOCALE_VALUE
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.INPUT_FOCUS
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.InvokeBlurEvent(Microsoft.AspNetCore.Components.Web.FocusEventArgs)
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.InvokeChangeEvent(System.EventArgs)
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.InvokeFocusEvent(Microsoft.AspNetCore.Components.Web.FocusEventArgs)
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.InvokeOpenEvent(System.Boolean, System.EventArgs)
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.IsCalendarRender
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.IsCalendarRendered
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.IsDatePickerPopup
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.IsDateTimeType()
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.IsDevice
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.IsExtendedDevicePopup()
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.IsListRender
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.KeyboardTimePopupAction()
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.MaskPlaceholderDictionary
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.MINUTE_LOCALE_KEY
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.MINUTE_LOCALE_VALUE
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.MODEL
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.MODEL_DAY
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.MODEL_HEADER
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.MODEL_MONTH
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.MODEL_YEAR
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.ModelDay
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.ModelMonth
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.ModelYear
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.MONTH_LOCALE_KEY
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.MONTH_LOCALE_VALUE
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.MouseIconHandler(System.EventArgs, System.String)
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.OnAfterRenderAsync(System.Boolean)
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.OnInitializedAsync()
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.OnParametersSetAsync()
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.POPUP
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.POPUP_EXPAND
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.POPUP_HOLDER
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.PopupCloseHandler()
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.PopupContainer
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.PopupElement
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.PopupEventArgs
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.PopupHolderEle
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.PreviousElementValue
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.READ_ONLY
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.ROOT
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.ScrollToNextSection(System.Boolean)
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.SECOND_LOCALE_KEY
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.SECOND_LOCALE_VALUE
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.SelectCalendar(System.Boolean)
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.ShowPopupCalendar
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.StrictModeUpdate(System.Boolean)
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.TimeIconHandler(System.EventArgs)
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.TRUE
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.UpdateChildProperties(System.Object)
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.UpdateErrorClass()
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.UpdateFieldSetStatus(System.Boolean)
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.UpdateInput()
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.UpdateValue(System.Object)
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.YEAR_LOCALE_KEY
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.YEAR_LOCALE_VALUE
    Syncfusion.Blazor.Inputs.SfInputTextBase<TValue>.BlurHandler(System.String, System.Boolean)
    Syncfusion.Blazor.Inputs.SfInputTextBase<TValue>.ClickStopPropagation
    Syncfusion.Blazor.Inputs.SfInputTextBase<TValue>.ContainerClass
    Syncfusion.Blazor.Inputs.SfInputTextBase<TValue>.IsValueTemplate
    Syncfusion.Blazor.Inputs.SfInputTextBase<TValue>.MouseDowSpinnerPrevent
    Syncfusion.Blazor.Inputs.SfInputTextBase<TValue>.MousePreventContainer
    Syncfusion.Blazor.Inputs.SfInputTextBase<TValue>.OnBlur
    Syncfusion.Blazor.Inputs.SfInputTextBase<TValue>.OnChange
    Syncfusion.Blazor.Inputs.SfInputTextBase<TValue>.OnFocus
    Syncfusion.Blazor.Inputs.SfInputTextBase<TValue>.OnInput
    Syncfusion.Blazor.Inputs.SfInputTextBase<TValue>.OnPaste
    Syncfusion.Blazor.Inputs.SfInputTextBase<TValue>.PreventIconHandler
    Syncfusion.Blazor.Inputs.SfInputTextBase<TValue>.RootClass
    Syncfusion.Blazor.Inputs.SfInputTextBase<TValue>.SpinButton
    Syncfusion.Blazor.Inputs.SfInputTextBase<TValue>.ValueExpression
    Syncfusion.Blazor.Inputs.SfInputTextBase<TValue>.ValueTemplate
    Namespace: Syncfusion.Blazor.Calendars
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class SfDateTimePicker<TValue> : SfDatePicker<TValue>, IMaskPlaceholder
    Type Parameters
    Name Description
    TValue

    Specifies the type of SfDateTimePicker.

    Constructors

    SfDateTimePicker()

    Declaration
    public SfDateTimePicker()

    Properties

    Max

    Gets or sets the maximum date and time value that can be allowed to select in SfDateTimePicker<TValue>.

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

    The DateTime value that represents the maximum date and time that can be selected. The default value is DateTime.MaxValue.

    Overrides
    Syncfusion.Blazor.Calendars.CalendarBase<TValue>.Max
    Remarks

    The Max value defines the latest date and time that can be selected in the DateTimePicker. When combined with MaxTime, the following behaviors apply:

    • If MaxTime is greater than the current Max property’s time, the component will prioritize Max.
    • If MaxTime is less than the current Max property’s time, the component will prioritize MaxTime.

    MaxTime

    Gets or sets the maximum time that can be selected in the time popup of the SfDateTimePicker<TValue>.

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

    The maximum selectable time. The default value is null.

    Remarks

    The MaxTime value restricts the time selection for all dates except the date defined by Max. The following behaviors apply:

    • If MaxTime is greater than the current Max property’s time, the component will prioritize Max.
    • If MaxTime is less than the current Max property’s time, the component will prioritize MaxTime.
    Examples
     
     
    
    @code{ 
        DateTime? MinTime = new DateTime(2024, 8, 6, 9, 0); 
        DateTime? MaxTime = new DateTime(2024, 8, 6, 18, 0); 
    } 

    Min

    Gets or sets the minimum date and time value that can be allowed to select in SfDateTimePicker<TValue>.

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

    The DateTime value that represents the minimum date and time that can be selected. The default value is DateTime.MinValue.

    Overrides
    Syncfusion.Blazor.Calendars.CalendarBase<TValue>.Min
    Remarks

    The Min value defines the earliest date and time that can be selected in the DateTimePicker. When combined with MinTime, the following behaviors apply:

    • If MinTime is less than the current Min property’s time, the component will prioritize Min.
    • If MinTime is greater than the current Min property’s time, the component will prioritize MinTime.

    MinTime

    Gets or sets the minimum time that can be selected in the time popup of the SfDateTimePicker<TValue>.

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

    The minimum selectable time. The default value is null.

    Remarks

    The MinTime value restricts the time selection for all dates except the date defined by Min. The following behaviors apply:

    • If MinTime is less than the current Min property’s time, the component will prioritize Min.
    • If MinTime is greater than the current Min property’s time, the component will prioritize MinTime.
    Examples
     
     
    
    @code{ 
        DateTime? MinTime = new DateTime(2024, 8, 6, 9, 0); 
        DateTime? MaxTime = new DateTime(2024, 8, 6, 18, 0); 
    } 

    ScrollTo

    Gets or sets the scroll bar position, if there is no value is selected in the DateTimePicker popup list or the given value is not present in the DateTimePicker popup list.

    Declaration
    public Nullable<DateTime> ScrollTo { get; set; }
    Property Value
    Type Description
    System.Nullable<System.DateTime>

    A DateTime value is set to ScrollTo property. If there is no value is selected in the popup list or the given value is not present in the popup list.

    Step

    Gets or sets the time interval between the two adjacent time values in the time popup list .

    Declaration
    public int Step { get; set; }
    Property Value
    Type Description
    System.Int32

    Accepts an integer value that specifies the time interval between two adjacent time values in the time popup list. The default value is 30.

    TimeFormat

    Gets or sets the format of the time value that to be displayed in time popup list.

    Declaration
    public string TimeFormat { get; set; }
    Property Value
    Type Description
    System.String

    Accepts time format value as string type. The default value is "".

    TimeIcon

    Declaration
    protected string TimeIcon { get; set; }
    Property Value
    Type
    System.String

    Methods

    BuildRenderTree(RenderTreeBuilder)

    Declaration
    protected override void BuildRenderTree(RenderTreeBuilder __builder)
    Parameters
    Type Name Description
    Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder
    Overrides
    Syncfusion.Blazor.Calendars.SfDatePicker<TValue>.BuildRenderTree(Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder)

    ShowDatePopup()

    Opens the popup to show the calendar.

    Declaration
    public Task ShowDatePopup()
    Returns
    Type Description
    System.Threading.Tasks.Task

    The System.Threading.Tasks.Task.

    ShowDatePopupAsync()

    Opens the popup to show the list items.

    Declaration
    public Task ShowDatePopupAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task

    The System.Threading.Tasks.Task.

    ShowTimePopupAsync()

    Opens the popup to show the list items.

    Declaration
    public Task ShowTimePopupAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task

    The System.Threading.Tasks.Task.

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