menu

MAUI

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

    Show / Hide Table of Contents

    Class SfTimePicker

    Initializes a new instance of the SfTimePicker class that represents a control, used to select the time with in specified list of times.

    Inheritance
    System.Object
    SfView
    PickerBase
    SfTimePicker
    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 SfTimePicker : 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

    SfTimePicker()

    Initializes a new instance of the SfTimePicker class.

    Declaration
    public SfTimePicker()

    Fields

    BlackoutTimesProperty

    Identifies the BlackoutTimes dependency property.

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

    The identifier for BlackoutTimes 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.

    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.

    HourIntervalProperty

    Identifies the HourInterval dependency property.

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

    The identifier for HourInterval dependency property.

    MaximumTimeProperty

    Identifies the MaximumTime dependency property.

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

    The identifier for MaximumTime dependency property.

    MinimumTimeProperty

    Identifies the MinimumTime dependency property.

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

    The identifier for MinimumTime dependency property.

    MinuteIntervalProperty

    Identifies the MinuteInterval dependency property.

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

    The identifier for MinuteInterval dependency property.

    SecondIntervalProperty

    Identifies the SecondInterval dependency property.

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

    The identifier for SecondInterval dependency property.

    SelectedTimeProperty

    Identifies the SelectedTime dependency property.

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

    The identifier for SelectedTime 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.

    Properties

    BlackoutTimes

    Gets or sets the BlackoutTimes in SfTimePicker.

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

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

    ColumnHeaderView

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

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

    Format

    Gets or sets the picker date format in SfTimePicker.

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

    HeaderView

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

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

    HourInterval

    Gets or sets the hour interval in SfTimePicker.

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

    MaximumTime

    Gets or sets the maximum time in SfTimePicker.

    Declaration
    public TimeSpan MaximumTime { get; set; }
    Property Value
    Type
    System.TimeSpan

    MinimumTime

    Gets or sets the minimum time in SfTimePicker.

    Declaration
    public TimeSpan MinimumTime { get; set; }
    Property Value
    Type
    System.TimeSpan

    MinuteInterval

    Gets or sets the minute interval in SfTimePicker.

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

    SecondInterval

    Gets or sets the second interval in SfTimePicker.

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

    SelectedTime

    Gets or sets the time picker selection time in SfTimePicker.

    Declaration
    public Nullable<TimeSpan> SelectedTime { get; set; }
    Property Value
    Type
    System.Nullable<System.TimeSpan>

    SelectionChangedCommand

    Gets or sets the selection changed command in SfTimePicker.

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

    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 the time picker cancel button clicked.

    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 the time picker ok button clicked.

    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 the time picker popup closed.

    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 the time picker popup closing.

    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 the time picker popup opened.

    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 time is changed on SfTimePicker.

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

    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