Class TimePicker

Represents a control that allows the user to select a time.

Inheritance
System.Object
DependencyObject
UIElement
FrameworkElement
Control
Picker
TimePicker
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: System.Windows.Controls
Assembly: OpenSilver.Controls.Input.Toolkit.dll
Syntax
[TemplatePart(Name = "TimeUpDown", Type = typeof(TimeUpDown))]
[TemplatePart(Name = "Popup", Type = typeof(Popup))]
[TemplatePart(Name = "DropDownToggle", Type = typeof(ToggleButton))]
[TemplatePart(Name = "PopupPlaceHolder", Type = typeof(ContentControl))]
[StyleTypedProperty(Property = "TimeUpDownStyle", StyleTargetType = typeof(TimeUpDown))]
[StyleTypedProperty(Property = "SpinnerStyle", StyleTargetType = typeof(ButtonSpinner))]
public class TimePicker : Picker, IControl, IFrameworkElement, IUIElement, IDependencyObject
Remarks

TimeInput supports only the following formatting characters: 'h', 'm', 's', 'H', 't'. All other characters are filtered out: 'd', 'f', 'F', 'g', 'K', 'M', 'y', 'z'.

Constructors

| Improve this Doc View Source

TimePicker()

Initializes a new instance of the TimePicker class.

Declaration
public TimePicker()

Fields

| Improve this Doc View Source

CultureProperty

Identifies the Culture dependency property.

Declaration
public static readonly DependencyProperty CultureProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

FormatProperty

Identifies the Format dependency property.

Declaration
public static readonly DependencyProperty FormatProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

MaximumProperty

Identifies the Maximum dependency property.

Declaration
public static readonly DependencyProperty MaximumProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

MinimumProperty

Identifies the Minimum dependency property.

Declaration
public static readonly DependencyProperty MinimumProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

PopupMinutesIntervalProperty

Identifies the PopupMinutesInterval dependency property.

Declaration
public static readonly DependencyProperty PopupMinutesIntervalProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

PopupProperty

Identifies the Popup dependency property.

Declaration
public static readonly DependencyProperty PopupProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

PopupSecondsIntervalProperty

Identifies the PopupSecondsInterval dependency property.

Declaration
public static readonly DependencyProperty PopupSecondsIntervalProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

PopupTemplateProperty

Identifies the PopupTemplate dependency property.

Declaration
public static readonly DependencyProperty PopupTemplateProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

PopupTimeSelectionModeProperty

Identifies the PopupTimeSelectionMode dependency property.

Declaration
public static readonly DependencyProperty PopupTimeSelectionModeProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

SpinnerStyleProperty

Identifies the SpinnerStyle dependency property.

Declaration
public static readonly DependencyProperty SpinnerStyleProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

TimeGlobalizationInfoProperty

Identifies the TimeGlobalizationInfo dependency property.

Declaration
public static readonly DependencyProperty TimeGlobalizationInfoProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

TimeParsersProperty

Identifies the TimeParsers dependency property.

Declaration
public static readonly DependencyProperty TimeParsersProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

TimeUpDownStyleProperty

Identifies the TimeUpDownStyle dependency property.

Declaration
public static readonly DependencyProperty TimeUpDownStyleProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

ValueProperty

Identifies the Value dependency property.

Declaration
public static readonly DependencyProperty ValueProperty
Field Value
Type Description
DependencyProperty

Properties

| Improve this Doc View Source

ActualCulture

Gets the actual culture used by the control for formatting and parsing.

Declaration
public CultureInfo ActualCulture { get; }
Property Value
Type Description
System.Globalization.CultureInfo
| Improve this Doc View Source

ActualFormat

Gets the actual format that will be used to display Time in the TimePicker. If no format is specified, ShortTimeFormat is used.

Declaration
public ITimeFormat ActualFormat { get; }
Property Value
Type Description
ITimeFormat

The actual display format.
| Improve this Doc View Source

ActualTimeGlobalizationInfo

Gets the actual TimeGlobalization info used by the control.

Declaration
public TimeGlobalizationInfo ActualTimeGlobalizationInfo { get; }
Property Value
Type Description
TimeGlobalizationInfo
Remarks

If TimeGlobalizationInfo is not set, will return default TimeGlobalizationInfo instance.

| Improve this Doc View Source

ActualTimeParsers

Gets the actual TimeParsers that will be used for parsing by the control.

Declaration
public TimeParserCollection ActualTimeParsers { get; }
Property Value
Type Description
TimeParserCollection
Remarks

Includes the TimeParsers introduced in the TimeGlobalizationInfo.

| Improve this Doc View Source

ActualTimePickerPopup

Gets the TimePickerPopup that is used by the TimePicker. This can be either a popup created from the PopupTemplate, or a popup set directly to the Popup property. When both are set, the Popup property will win.

Declaration
protected virtual TimePickerPopup ActualTimePickerPopup { get; }
Property Value
Type Description
TimePickerPopup
| Improve this Doc View Source

Culture

Gets or sets the culture that will be used by the control for parsing and formatting.

Declaration
public CultureInfo Culture { get; set; }
Property Value
Type Description
System.Globalization.CultureInfo
| Improve this Doc View Source

Format

Gets or sets the Format used by the control. From XAML Use either "Short", "Long" or a custom format. Custom formats can only contain "H", "h", "m", "s" or "t". For example: use 'hh:mm:ss' is used to format time as "13:45:30".

Declaration
[TypeConverter(typeof(TimeFormatConverter))]
public ITimeFormat Format { get; set; }
Property Value
Type Description
ITimeFormat
| Improve this Doc View Source

Maximum

Gets or sets the maximum time considered valid by the control.

Declaration
[TypeConverter(typeof(TimeTypeConverter))]
public DateTime? Maximum { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>
Remarks

Setting the Maximum property is applicable for the following features: Selecting a value through a popup, Parsing a new value from the textbox, spinning a new value and programmatically specifying a value.

| Improve this Doc View Source

Minimum

Gets or sets the minimum time considered valid by the control.

Declaration
[TypeConverter(typeof(TimeTypeConverter))]
public DateTime? Minimum { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>
Remarks

Setting the minimum property is applicable for the following features: Selecting a value through a popup, Parsing a new value from the textbox, spinning a new value and programmatically specifying a value.

| Improve this Doc View Source

Popup

Gets or sets the TimePickerPopup that will be shown to the user by the TimePicker control. This property may not be styled. To style a TimePicker with a Popup, please use the PopupTemplate property. When both PopupTemplate and Popup are set, Popup will be used.

Declaration
public TimePickerPopup Popup { get; set; }
Property Value
Type Description
TimePickerPopup
| Improve this Doc View Source

PopupMinutesInterval

Gets or sets the minutes interval between time values allowed by the TimePickerPopup.

Declaration
public int PopupMinutesInterval { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

PopupSecondsInterval

Gets or sets the seconds interval between time values allowed by the TimePickerPopup.

Declaration
public int PopupSecondsInterval { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

PopupTemplate

Gets or sets the template used as Popup. A Popup can also be set directly on the Popup property. When both PopupTemplate and Popup are set, Popup will be used.

Declaration
public TimePickerPopupTemplate PopupTemplate { get; set; }
Property Value
Type Description
TimePickerPopupTemplate
| Improve this Doc View Source

PopupTimeSelectionMode

Gets or sets the whether the TimePickerPopup supports selecting designators and/or seconds.

Declaration
public PopupTimeSelectionMode PopupTimeSelectionMode { get; set; }
Property Value
Type Description
PopupTimeSelectionMode
| Improve this Doc View Source

SpinnerStyle

Gets or sets the Style that is applied to the spinner.

Declaration
public Style SpinnerStyle { get; set; }
Property Value
Type Description
Style
| Improve this Doc View Source

TimeGlobalizationInfo

Gets or sets the strategy object that determines how the control interacts with DateTime and CultureInfo.

Declaration
public TimeGlobalizationInfo TimeGlobalizationInfo { get; set; }
Property Value
Type Description
TimeGlobalizationInfo
| Improve this Doc View Source

TimeParsers

Gets or sets a collection of TimeParsers that are used when parsing text to time.

Declaration
public TimeParserCollection TimeParsers { get; set; }
Property Value
Type Description
TimeParserCollection
| Improve this Doc View Source

TimeUpDownStyle

Gets or sets the Style applied to the TimeUpDown portion of the TimePicker control.

Declaration
public Style TimeUpDownStyle { get; set; }
Property Value
Type Description
Style
| Improve this Doc View Source

Value

Gets or sets the currently selected time.

Declaration
[TypeConverter(typeof(TimeTypeConverter))]
public virtual DateTime? Value { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>

Methods

| Improve this Doc View Source

GetSelectedValue()

Gets the selected time represented in the control.

Declaration
public override object GetSelectedValue()
Returns
Type Description
System.Object

The value that is picked.
Overrides
| Improve this Doc View Source

OnApplyTemplate()

Builds the visual tree for the TimePicker control when a new template is applied.

Declaration
public override void OnApplyTemplate()
Overrides
| Improve this Doc View Source

OnCreateAutomationPeer()

Returns a PickerAutomationPeer for use by the Silverlight automation infrastructure.

Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
Type Description
AutomationPeer

A PickerAutomationPeer for the Picker object.
Overrides
| Improve this Doc View Source

OnDropDownClosed(RoutedPropertyChangedEventArgs<Boolean>)

Raises an DropDownClosed event when the IsDropDownOpen property changed from true to false.

Declaration
protected override void OnDropDownClosed(RoutedPropertyChangedEventArgs<bool> e)
Parameters
Type Name Description
RoutedPropertyChangedEventArgs<System.Boolean> e

The event data.
Overrides
| Improve this Doc View Source

OnDropDownOpened(RoutedPropertyChangedEventArgs<Boolean>)

Raises an DropDownOpened event when the IsDropDownOpen property changed from false to true.

Declaration
protected override void OnDropDownOpened(RoutedPropertyChangedEventArgs<bool> e)
Parameters
Type Name Description
RoutedPropertyChangedEventArgs<System.Boolean> e

The event data.
Overrides
| Improve this Doc View Source

OnMaximumChanged(Nullable<DateTime>, Nullable<DateTime>)

Called when the Maximum property value has changed.

Declaration
protected virtual void OnMaximumChanged(DateTime? oldValue, DateTime? newValue)
Parameters
Type Name Description
System.Nullable<System.DateTime> oldValue

Old value of the Maximum property.
System.Nullable<System.DateTime> newValue

New value of the Maximum property.
| Improve this Doc View Source

OnMinimumChanged(Nullable<DateTime>, Nullable<DateTime>)

Called when the Minimum property value has changed.

Declaration
protected virtual void OnMinimumChanged(DateTime? oldValue, DateTime? newValue)
Parameters
Type Name Description
System.Nullable<System.DateTime> oldValue

Old value of the Minimum property.
System.Nullable<System.DateTime> newValue

New value of the Minimum property.
| Improve this Doc View Source

OnValueChanged(RoutedPropertyChangedEventArgs<Nullable<DateTime>>)

Raises the ValueChanged event when Value property has changed.

Declaration
protected virtual void OnValueChanged(RoutedPropertyChangedEventArgs<DateTime?> e)
Parameters
Type Name Description
RoutedPropertyChangedEventArgs<System.Nullable<System.DateTime>> e

Event args.
| Improve this Doc View Source

OnValueChanging(RoutedPropertyChangingEventArgs<Nullable<DateTime>>)

Raises the ValueChanging event when Value property is changing.

Declaration
protected virtual void OnValueChanging(RoutedPropertyChangingEventArgs<DateTime?> e)
Parameters
Type Name Description
RoutedPropertyChangingEventArgs<System.Nullable<System.DateTime>> e

Event args.

Events

| Improve this Doc View Source

ParseError

Occurs when there is an error in parsing user input and allows adding parsing logic.

Declaration
public event EventHandler<UpDownParseErrorEventArgs> ParseError
Event Type
Type Description
System.EventHandler<UpDownParseErrorEventArgs>
| Improve this Doc View Source

Parsing

Occurs when a value is being parsed and allows custom parsing.

Declaration
public event EventHandler<UpDownParsingEventArgs<DateTime?>> Parsing
Event Type
Type Description
System.EventHandler<UpDownParsingEventArgs<System.Nullable<System.DateTime>>>
| Improve this Doc View Source

ValueChanged

Occurs when Value property has changed.

Declaration
public event RoutedPropertyChangedEventHandler<DateTime?> ValueChanged
Event Type
Type Description
RoutedPropertyChangedEventHandler<System.Nullable<System.DateTime>>
| Improve this Doc View Source

ValueChanging

Occurs when Value property is changing.

Declaration
public event RoutedPropertyChangingEventHandler<DateTime?> ValueChanging
Event Type
Type Description
RoutedPropertyChangingEventHandler<System.Nullable<System.DateTime>>

Extension Methods