menu

MAUI

  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class SfDatePicker - MAUI API Reference | Syncfusion

    Show / Hide Table of Contents

    Class SfDatePicker

    Initializes a new instance of the SfDatePicker class that represents a control, used to select the date with in specified date range.

    Inheritance
    System.Object
    SfView
    PickerBase
    SfDatePicker
    Implements
    IDrawableLayout
    Microsoft.Maui.Graphics.IDrawable
    Microsoft.Maui.IAbsoluteLayout
    Microsoft.Maui.ILayout
    Microsoft.Maui.IView
    Microsoft.Maui.IElement
    Microsoft.Maui.ITransform
    Microsoft.Maui.IContainer
    System.Collections.Generic.IList<Microsoft.Maui.IView>
    System.Collections.Generic.ICollection<Microsoft.Maui.IView>
    System.Collections.Generic.IEnumerable<Microsoft.Maui.IView>
    System.Collections.IEnumerable
    Microsoft.Maui.ISafeAreaView
    Microsoft.Maui.IPadding
    Microsoft.Maui.ICrossPlatformLayout
    Microsoft.Maui.IVisualTreeElement
    Inherited Members
    PickerBase.AcceptCommand
    PickerBase.AcceptCommandProperty
    PickerBase.ArrangeContent(Rect)
    PickerBase.CancelButtonClicked
    PickerBase.Closed
    PickerBase.Closing
    PickerBase.ColumnDividerColor
    PickerBase.ColumnDividerColorProperty
    PickerBase.ColumnHeaderTemplate
    PickerBase.ColumnHeaderTemplateProperty
    PickerBase.DeclineCommand
    PickerBase.DeclineCommandProperty
    PickerBase.EnableLooping
    PickerBase.EnableLoopingProperty
    PickerBase.FooterTemplate
    PickerBase.FooterTemplateProperty
    PickerBase.FooterView
    PickerBase.FooterViewProperty
    PickerBase.HeaderTemplate
    PickerBase.HeaderTemplateProperty
    PickerBase.IsOpen
    PickerBase.IsOpenProperty
    PickerBase.ItemHeight
    PickerBase.ItemHeightProperty
    PickerBase.MeasureContent(Double, Double)
    PickerBase.Mode
    PickerBase.ModeProperty
    PickerBase.OkButtonClicked
    PickerBase.OnHeaderButtonClicked(Int32)
    PickerBase.OnPickerLoading()
    PickerBase.OnPropertyChanged(String)
    PickerBase.Opened
    PickerBase.PopupHeight
    PickerBase.PopupHeightProperty
    PickerBase.PopupWidth
    PickerBase.PopupWidthProperty
    PickerBase.RelativePosition
    PickerBase.RelativePositionProperty
    PickerBase.RelativeView
    PickerBase.RelativeViewProperty
    PickerBase.SelectedTextStyle
    PickerBase.SelectedTextStyleProperty
    PickerBase.SelectionView
    PickerBase.SelectionViewProperty
    PickerBase.TextDisplayMode
    PickerBase.TextDisplayModeProperty
    PickerBase.TextStyle
    PickerBase.TextStyleProperty
    SfView.ArrangeOverride(Rect)
    SfView.Children
    SfView.ClipToBounds
    SfView.GetSemanticsNodesCore(Double, Double)
    SfView.IDrawableLayout.DrawingOrder
    SfView.IDrawableLayout.InvalidateDrawable()
    SfView.MeasureOverride(Double, Double)
    SfView.OnDraw(ICanvas, RectF)
    SfView.OnHandlerChanged()
    SfView.Padding
    Namespace: Syncfusion.Maui.Picker
    Assembly: Syncfusion.Maui.Picker.dll
    Syntax
    public class SfDatePicker : PickerBase, IDrawableLayout, IDrawable, IAbsoluteLayout, ILayout, IView, IElement, ITransform, IContainer, IList<IView>, ICollection<IView>, IEnumerable<IView>, IEnumerable, ISafeAreaView, IPadding, ICrossPlatformLayout, IVisualTreeElement, ISemanticsProvider, IPicker, IPickerView, IColumnHeaderView, IFooterView, IHeaderView, IPickerCommon, IParentThemeElement, IThemeElement

    Constructors

    SfDatePicker()

    Initializes a new instance of the SfDatePicker class.

    Declaration
    public SfDatePicker()

    Fields

    BlackoutDatesProperty

    Identifies the BlackoutDates dependency property.

    Declaration
    public static readonly BindableProperty BlackoutDatesProperty
    Field Value
    Type Description
    Microsoft.Maui.Controls.BindableProperty

    The identifier for BlackoutDates dependency property.

    ColumnHeaderViewProperty

    Identifies the ColumnHeaderView dependency property.

    Declaration
    public static readonly BindableProperty ColumnHeaderViewProperty
    Field Value
    Type Description
    Microsoft.Maui.Controls.BindableProperty

    The identifier for ColumnHeaderView dependency property.

    DayIntervalProperty

    Identifies the DayInterval dependency property.

    Declaration
    public static readonly BindableProperty DayIntervalProperty
    Field Value
    Type Description
    Microsoft.Maui.Controls.BindableProperty

    The identifier for DayInterval dependency property.

    FormatProperty

    Identifies the Format dependency property.

    Declaration
    public static readonly BindableProperty FormatProperty
    Field Value
    Type Description
    Microsoft.Maui.Controls.BindableProperty

    The identifier for Format dependency property.

    HeaderViewProperty

    Identifies the HeaderView dependency property.

    Declaration
    public static readonly BindableProperty HeaderViewProperty
    Field Value
    Type Description
    Microsoft.Maui.Controls.BindableProperty

    The identifier for HeaderView dependency property.

    MaximumDateProperty

    Identifies the MaximumDate dependency property.

    Declaration
    public static readonly BindableProperty MaximumDateProperty
    Field Value
    Type Description
    Microsoft.Maui.Controls.BindableProperty

    The identifier for MaximumDate dependency property.

    MinimumDateProperty

    Identifies the MinimumDate dependency property.

    Declaration
    public static readonly BindableProperty MinimumDateProperty
    Field Value
    Type Description
    Microsoft.Maui.Controls.BindableProperty

    The identifier for MinimumDate dependency property.

    MonthIntervalProperty

    Identifies the MonthInterval dependency property.

    Declaration
    public static readonly BindableProperty MonthIntervalProperty
    Field Value
    Type Description
    Microsoft.Maui.Controls.BindableProperty

    The identifier for MonthInterval dependency property.

    SelectedDateProperty

    Identifies the SelectedDate dependency property.

    Declaration
    public static readonly BindableProperty SelectedDateProperty
    Field Value
    Type Description
    Microsoft.Maui.Controls.BindableProperty

    The identifier for SelectedDate dependency property.

    SelectionChangedCommandProperty

    Identifies the SelectionChangedCommand dependency property.

    Declaration
    public static readonly BindableProperty SelectionChangedCommandProperty
    Field Value
    Type Description
    Microsoft.Maui.Controls.BindableProperty

    The identifier for SelectionChangedCommand dependency property.

    YearIntervalProperty

    Identifies the YearInterval dependency property.

    Declaration
    public static readonly BindableProperty YearIntervalProperty
    Field Value
    Type Description
    Microsoft.Maui.Controls.BindableProperty

    The identifier for YearInterval dependency property.

    Properties

    BlackoutDates

    Gets or sets the BlackoutDates in SfDatePicker.

    Declaration
    public ObservableCollection<DateTime> BlackoutDates { get; set; }
    Property Value
    Type
    System.Collections.ObjectModel.ObservableCollection<System.DateTime>
    Remarks

    The selection view will not be applicable when setting blackout dates.

    ColumnHeaderView

    Gets or sets the value of column header view. This property can be used to customize the header column in SfDatePicker.

    Declaration
    public DatePickerColumnHeaderView ColumnHeaderView { get; set; }
    Property Value
    Type
    DatePickerColumnHeaderView

    DayInterval

    Gets or sets the day interval in SfDatePicker.

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

    Format

    Gets or sets the picker date format in SfDatePicker.

    Declaration
    public PickerDateFormat Format { get; set; }
    Property Value
    Type
    PickerDateFormat

    HeaderView

    Gets or sets the value of header view. This property can be used to customize the header in SfDatePicker.

    Declaration
    public PickerHeaderView HeaderView { get; set; }
    Property Value
    Type
    PickerHeaderView

    MaximumDate

    Gets or sets the maximum date in SfDatePicker.

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

    MinimumDate

    Gets or sets the minimum date in SfDatePicker.

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

    MonthInterval

    Gets or sets the month interval in SfDatePicker.

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

    SelectedDate

    Gets or sets the date picker selection date in SfDatePicker.

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

    SelectionChangedCommand

    Gets or sets the selection changed command in SfDatePicker.

    Declaration
    public ICommand SelectionChangedCommand { get; set; }
    Property Value
    Type
    System.Windows.Input.ICommand

    YearInterval

    Gets or sets the year interval in SfDatePicker.

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

    Methods

    Initialize()

    Method to wire the events.

    Declaration
    protected override void Initialize()
    Overrides
    PickerBase.Initialize()

    OnBindingContextChanged()

    Method triggers when the property binding context changed.

    Declaration
    protected override void OnBindingContextChanged()
    Overrides
    SfView.OnBindingContextChanged()

    OnCancelButtonClicked(EventArgs)

    Method triggers when clicked the date picker cancel button.

    Declaration
    protected override void OnCancelButtonClicked(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    The event arguments.

    Overrides
    PickerBase.OnCancelButtonClicked(EventArgs)

    OnOkButtonClicked(EventArgs)

    Method triggers when clicked the date picker ok button.

    Declaration
    protected override void OnOkButtonClicked(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    The event arguments

    Overrides
    PickerBase.OnOkButtonClicked(EventArgs)

    OnPopupClosed(EventArgs)

    Method triggers when closed the date picker popup.

    Declaration
    protected override void OnPopupClosed(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    The event arguments.

    Overrides
    PickerBase.OnPopupClosed(EventArgs)

    OnPopupClosing(CancelEventArgs)

    Method triggers when closing the date picker popup.

    Declaration
    protected override void OnPopupClosing(CancelEventArgs e)
    Parameters
    Type Name Description
    System.ComponentModel.CancelEventArgs e

    The event arguments.

    Overrides
    PickerBase.OnPopupClosing(CancelEventArgs)

    OnPopupOpened(EventArgs)

    Method triggers when opened the date picker popup.

    Declaration
    protected override void OnPopupOpened(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    The event arguments.

    Overrides
    PickerBase.OnPopupOpened(EventArgs)

    Events

    SelectionChanged

    Occurs after the selected date is changed on SfDatePicker.

    Declaration
    public event EventHandler<DatePickerSelectionChangedEventArgs> SelectionChanged
    Event Type
    Type
    System.EventHandler<DatePickerSelectionChangedEventArgs>

    Implements

    IDrawableLayout
    Microsoft.Maui.Graphics.IDrawable
    Microsoft.Maui.IAbsoluteLayout
    Microsoft.Maui.ILayout
    Microsoft.Maui.IView
    Microsoft.Maui.IElement
    Microsoft.Maui.ITransform
    Microsoft.Maui.IContainer
    System.Collections.Generic.IList<>
    System.Collections.Generic.ICollection<>
    System.Collections.Generic.IEnumerable<>
    System.Collections.IEnumerable
    Microsoft.Maui.ISafeAreaView
    Microsoft.Maui.IPadding
    Microsoft.Maui.ICrossPlatformLayout
    Microsoft.Maui.IVisualTreeElement
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved