menu

Xamarin.Forms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class SfTimePicker - Xamarin.Forms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class SfTimePicker

    SfTimePicker is a picker control allows you to pick a time value. You can customize it by setting start time, end time, Time format etc.

    Inheritance
    System.Object
    PickerBase
    SfTimePicker
    Implements
    System.IDisposable
    Inherited Members
    PickerBase.BackgroundColor
    PickerBase.BackgroundColorProperty
    PickerBase.BorderColor
    PickerBase.BorderColorProperty
    PickerBase.CancelButtonBackgroundColor
    PickerBase.CancelButtonBackgroundColorProperty
    PickerBase.CancelButtonTextColor
    PickerBase.CancelButtonTextColorProperty
    PickerBase.ColumnHeaderBackgroundColor
    PickerBase.ColumnHeaderBackgroundColorProperty
    PickerBase.ColumnHeaderFontAttribute
    PickerBase.ColumnHeaderFontAttributeProperty
    PickerBase.ColumnHeaderFontFamily
    PickerBase.ColumnHeaderFontFamilyProperty
    PickerBase.ColumnHeaderFontSize
    PickerBase.ColumnHeaderFontSizeProperty
    PickerBase.ColumnHeaderHeight
    PickerBase.ColumnHeaderHeightProperty
    PickerBase.ColumnHeaderTextColor
    PickerBase.ColumnHeaderTextColorProperty
    PickerBase.EnableLooping
    PickerBase.EnableLoopingProperty
    PickerBase.FooterHeight
    PickerBase.FooterHeightProperty
    PickerBase.FooterView
    PickerBase.FooterViewProperty
    PickerBase.HeaderBackgroundColor
    PickerBase.HeaderBackgroundColorProperty
    PickerBase.HeaderFontAttribute
    PickerBase.HeaderFontAttributeProperty
    PickerBase.HeaderFontFamily
    PickerBase.HeaderFontFamilyProperty
    PickerBase.HeaderFontSize
    PickerBase.HeaderFontSizeProperty
    PickerBase.HeaderHeight
    PickerBase.HeaderHeightProperty
    PickerBase.HeaderTextColor
    PickerBase.HeaderTextColorProperty
    PickerBase.HeaderView
    PickerBase.HeaderViewProperty
    PickerBase.IsOpen
    PickerBase.IsOpenProperty
    PickerBase.ItemHeight
    PickerBase.ItemHeightProperty
    PickerBase.OKButtonBackgroundColor
    PickerBase.OKButtonBackgroundColorProperty
    PickerBase.OKButtonTextColor
    PickerBase.OKButtonTextColorProperty
    PickerBase.Parent
    PickerBase.PickerHeight
    PickerBase.PickerHeightProperty
    PickerBase.PickerMode
    PickerBase.PickerModeProperty
    PickerBase.PickerWidth
    PickerBase.PickerWidthProperty
    PickerBase.SelectedItemFontAttribute
    PickerBase.SelectedItemFontAttributeProperty
    PickerBase.SelectedItemFontFamily
    PickerBase.SelectedItemFontFamilyProperty
    PickerBase.SelectedItemFontSize
    PickerBase.SelectedItemFontSizeProperty
    PickerBase.SelectedItemTextColor
    PickerBase.SelectedItemTextColorProperty
    PickerBase.SelectionBackgroundColor
    PickerBase.SelectionBackgroundColorProperty
    PickerBase.ShowColumnHeader
    PickerBase.ShowColumnHeaderProperty
    PickerBase.ShowFooter
    PickerBase.ShowFooterProperty
    PickerBase.ShowHeader
    PickerBase.ShowHeaderProperty
    PickerBase.UnselectedItemFontAttribute
    PickerBase.UnselectedItemFontAttributeProperty
    PickerBase.UnselectedItemFontFamily
    PickerBase.UnselectedItemFontFamilyProperty
    PickerBase.UnselectedItemFontSize
    PickerBase.UnselectedItemFontSizeProperty
    PickerBase.UnselectedItemTextColor
    PickerBase.UnselectedItemTextColorProperty
    Namespace: Syncfusion.XForms.Pickers
    Assembly: Syncfusion.SfPicker.XForms.dll
    Syntax
    public class SfTimePicker : PickerBase, IDisposable

    Constructors

    SfTimePicker()

    Initializes a new instance of the SfTimePicker class.

    Declaration
    public SfTimePicker()

    Fields

    CancelCommandProperty

    Identifies the CancelCommand dependency property. This property can be used to change the cancel command of the SfTimePicker control.

    Declaration
    public static readonly BindableProperty CancelCommandProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty
    Remarks

    This bindable property is read-only.

    CommandParameterProperty

    Identifies the CommandParameter dependency property. This property can be used to change the command parameter of the SfTimePicker control.

    Declaration
    public static readonly BindableProperty CommandParameterProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty
    Remarks

    This bindable property is read-only.

    FormatProperty

    Identifies the Format dependency property. This property can be used to change the format of the SfTimePicker control.

    Declaration
    public static readonly BindableProperty FormatProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    HeaderTextProperty

    Identifies the HeaderText dependency property. This property can be used to change the header text of the SfTimePicker control.

    Declaration
    public static readonly BindableProperty HeaderTextProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    HourHeaderTextProperty

    Identifies the HourHeaderText dependency property. This property can be used to change the hour header text of the SfTimePicker control.

    Declaration
    public static readonly BindableProperty HourHeaderTextProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    HourIntervalProperty

    Identifies the HourInterval dependency property. This property can be used to change the hour interval of the SfTimePicker control.

    Declaration
    public static readonly BindableProperty HourIntervalProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    MeridiemHeaderTextProperty

    Identifies the MeridiemHeaderText dependency property. This property can be used to change the meridiem header text of the SfTimePicker control.

    Declaration
    public static readonly BindableProperty MeridiemHeaderTextProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    MinuteIntervalProperty

    Identifies the MinuteInterval dependency property. This property can be used to change the minute interval of the SfTimePicker control.

    Declaration
    public static readonly BindableProperty MinuteIntervalProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    MinutesHeaderTextProperty

    Identifies the MinutesHeaderText dependency property. This property can be used to change the minutes header text of the SfTimePicker control.

    Declaration
    public static readonly BindableProperty MinutesHeaderTextProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    OkCommandProperty

    Identifies the OkCommand dependency property. This property can be used to change the ok command of the SfTimePicker control.

    Declaration
    public static readonly BindableProperty OkCommandProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty
    Remarks

    This bindable property is read-only.

    SecondIntervalProperty

    Identifies the SecondInterval dependency property. This property can be used to change the second interval of the SfTimePicker control.

    Declaration
    public static readonly BindableProperty SecondIntervalProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    SecondsHeaderTextProperty

    Identifies the SecondsHeaderText dependency property. This property can be used to change the seconds header text of the SfTimePicker control.

    Declaration
    public static readonly BindableProperty SecondsHeaderTextProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    TimeProperty

    Identifies the Time dependency property. This property can be used to change the time of the SfTimePicker control.

    Declaration
    public static readonly BindableProperty TimeProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    Properties

    CancelCommand

    Gets or sets the value of the Command. It invokes when the button is activated. It is a bindale property.

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

    The command.

    CommandParameter

    Gets or sets the value of the CommandParameter, which is a parameter to pass the Command property. This is a bindable property.

    Declaration
    public object CommandParameter { get; set; }
    Property Value
    Type Description
    System.Object

    The command parameter.

    Format

    Gets or sets the time format. This is a bindable property.

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

    HeaderText

    Gets or sets header text. This is a bindable property.

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

    HourHeaderText

    Gets or sets the hour text. This is a bindable property.

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

    HourInterval

    Gets or sets hour interval This is a bindable property.

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

    MeridiemHeaderText

    Gets or sets meridiem text. This is a bindable property.

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

    MinuteInterval

    Gets or sets minute interval. This is a bindable property.

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

    MinutesHeaderText

    Gets or sets minutes text. This is a bindable property.

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

    OkCommand

    Gets or sets the value of the Command. It invokes when the button is activated. It is a bindale property.

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

    The command.

    SecondInterval

    Gets or sets second interval. This is a bindable property.

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

    SecondsHeaderText

    Gets or sets seconds text. This is a bindable property.

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

    Time

    Gets or sets the time that defines the current selected time. This is a bindable property.

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

    Methods

    Dispose()

    Dispose method.

    Declaration
    public void Dispose()

    Events

    CancelButtonClicked

    Occurs when the default Cancel button clicked.

    Declaration
    public event EventHandler<TimeChangedEventArgs> CancelButtonClicked
    Event Type
    Type
    System.EventHandler<TimeChangedEventArgs>

    Closed

    The ClosedEvent occurs when close the SfTimePicker control.

    Declaration
    public event EventHandler<EventArgs> Closed
    Event Type
    Type
    System.EventHandler<System.EventArgs>

    Closing

    The ClosingEvent occurs when close the SfTimePicker control

    Declaration
    public event EventHandler<CancelEventArgs> Closing
    Event Type
    Type
    System.EventHandler<CancelEventArgs>

    OkButtonClicked

    Occurs when the default OK button clicked.

    Declaration
    public event EventHandler<TimeChangedEventArgs> OkButtonClicked
    Event Type
    Type
    System.EventHandler<TimeChangedEventArgs>

    Opened

    The OpendedEvent occurs when open the SfTimePicker control.

    Declaration
    public event EventHandler<EventArgs> Opened
    Event Type
    Type
    System.EventHandler<System.EventArgs>

    TimeSelected

    It represents the time changed event.

    Declaration
    public event EventHandler<TimeChangedEventArgs> TimeSelected
    Event Type
    Type
    System.EventHandler<TimeChangedEventArgs>

    Implements

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