Class RadTimeSpanPicker

Represents a control that allows the user to select System.TimeSpans.

Inheritance
System.Object
RadTimeSpanPicker
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.Input.dll

Syntax

[TelerikToolboxCategory("Input")]
public class RadTimeSpanPicker : Control, IThemable

Constructors

RadTimeSpanPicker()

Initializes a new instance of the RadTimeSpanPicker class.

Declaration
public RadTimeSpanPicker()

Fields

DropDownWidthProperty

Identifies the DropDownWidth dependency property.

Declaration
public static readonly DependencyProperty DropDownWidthProperty
Field Value
System.Windows.DependencyProperty

EditModeProperty

Identifies the EditMode dependency property.

Declaration
public static readonly DependencyProperty EditModeProperty
Field Value
System.Windows.DependencyProperty

GenerateDefaultComponentsProperty

Identifies the GenerateDefaultComponents dependency property.

Declaration
public static readonly DependencyProperty GenerateDefaultComponentsProperty
Field Value
System.Windows.DependencyProperty

IsDropDownOpenProperty

Identifies the IsDropDownOpen dependency property.

Declaration
public static readonly DependencyProperty IsDropDownOpenProperty
Field Value
System.Windows.DependencyProperty

MaxDropDownHeightProperty

Identifies the MaxDropDownHeight dependency property.

Declaration
public static readonly DependencyProperty MaxDropDownHeightProperty
Field Value
System.Windows.DependencyProperty

SpinModeProperty

Identifies the SpinMode dependency property.

Declaration
public static readonly DependencyProperty SpinModeProperty
Field Value
System.Windows.DependencyProperty

StringFormatProperty

Identifies the StringFormat dependency property.

Declaration
public static readonly DependencyProperty StringFormatProperty
Field Value
System.Windows.DependencyProperty

TabNavigationModeProperty

Identifies the TabNavigationMode dependency property.

Declaration
public static readonly DependencyProperty TabNavigationModeProperty
Field Value
System.Windows.DependencyProperty

TextAlignmentProperty

Identifies the TextAlignment dependency property.

Declaration
public static readonly DependencyProperty TextAlignmentProperty
Field Value
System.Windows.DependencyProperty

TimeSpanComponentsProperty

Identifies the TimeSpanComponents read-only dependency property.

Declaration
public static readonly DependencyProperty TimeSpanComponentsProperty
Field Value
System.Windows.DependencyProperty

TimeSpanComponentStyleProperty

Identifies the TimeSpanComponentStyle dependency property.

Declaration
public static readonly DependencyProperty TimeSpanComponentStyleProperty
Field Value
System.Windows.DependencyProperty

TimeSpanComponentStyleSelectorProperty

Identifies the TimeSpanComponentStyleSelector dependency property.

Declaration
public static readonly DependencyProperty TimeSpanComponentStyleSelectorProperty
Field Value
System.Windows.DependencyProperty

TimeSpanTextProperty

Identifies the TimeSpanText dependency property.

Declaration
public static readonly DependencyProperty TimeSpanTextProperty
Field Value
System.Windows.DependencyProperty

TimeSpanWatermarkContentProperty

Identifies the TimeSpanWatermarkContent dependency property.

Declaration
public static readonly DependencyProperty TimeSpanWatermarkContentProperty
Field Value
System.Windows.DependencyProperty

TimeSpanWatermarkTemplateProperty

Identifies the TimeSpanWatermarkTemplate dependency property.

Declaration
public static readonly DependencyProperty TimeSpanWatermarkTemplateProperty
Field Value
System.Windows.DependencyProperty

ValueProperty

Identifies the Value dependency property.

Declaration
public static readonly DependencyProperty ValueProperty
Field Value
System.Windows.DependencyProperty

Properties

DropDownWidth

Gets or sets the width for a RadTimeSpanPicker DropDown.

Declaration
public double DropDownWidth { get; set; }
Property Value
System.Double

EditMode

Gets or sets a value indicating the edit mode of the TimeSpanPicker control.

Declaration
public EditMode EditMode { get; set; }
Property Value
EditMode

GenerateDefaultComponents

Gets or sets a value that indicates whether the control will use the default - Day, Hour and Minute RadTimeSpanPickerComponents.

Declaration
public bool GenerateDefaultComponents { get; set; }
Property Value
System.Boolean

IsDropDownOpen

Gets or sets a value that indicates whether the DropDown button is open or closed.

Declaration
public bool IsDropDownOpen { get; set; }
Property Value
System.Boolean

True if this DropDown button is open; otherwise, false.

MaxDropDownHeight

Gets or sets the maximum height for a RadTimeSpanPicker DropDown.

Declaration
public double MaxDropDownHeight { get; set; }
Property Value
System.Double

SpinMode

Gets or sets a value indicating the spin mode of the TimeSpanPicker control.

Declaration
public SpinMode SpinMode { get; set; }
Property Value
SpinMode

StringFormat

Gets or sets a string that represents a valid format that can be used to format the string representation of any TimeSpan value.

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

TabNavigationMode

Gets or sets a value indicating the tab navigation mode of the TimeSpanPicker control.

Declaration
public TabNavigationMode TabNavigationMode { get; set; }
Property Value
TabNavigationMode

TextAlignment

Gets or sets the TextAlignment of the TextBox inside the RadTimeSpanPicker.

Declaration
public TextAlignment TextAlignment { get; set; }
Property Value
System.Windows.TextAlignment

The TextAlignment of the TextBox.

TimeSpanComponents

Gets the TimeSpanComponentCollection that is currently used in the RadTimeSpanPicker.

Declaration
public TimeSpanComponentCollection TimeSpanComponents { get; }
Property Value
TimeSpanComponentCollection

TimeSpanComponentStyle

Gets or sets the style for the RadTimeSpanPickerComponents of the RadTimeSpanPicker.

Declaration
public Style TimeSpanComponentStyle { get; set; }
Property Value
System.Windows.Style

TimeSpanComponentStyleSelector

Gets or sets the style selector for the RadTimeSpanPickerComponents of the RadTimeSpanPicker.

Declaration
public StyleSelector TimeSpanComponentStyleSelector { get; set; }
Property Value
System.Windows.Controls.StyleSelector

TimeSpanText

Gets the formatted string representing the Value.

Declaration
public string TimeSpanText { get; }
Property Value
System.String

TimeSpanWatermarkContent

Gets or sets the content of the RadTimeSpanPicker control when there is no entered text.

Declaration
public object TimeSpanWatermarkContent { get; set; }
Property Value
System.Object

TimeSpanWatermarkTemplate

Gets or sets the System.Windows.DataTemplate used to display TimeSpanWatermark when there is no selection.

Declaration
public DataTemplate TimeSpanWatermarkTemplate { get; set; }
Property Value
System.Windows.DataTemplate

Value

Gets or sets the Value of Telerik.Windows.Controls.RadTimeSpanPicker control.

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

Methods

OnApplicationCut(Object, ExecutedRoutedEventArgs)

Occurs when cut operation is executed.

Declaration
protected virtual void OnApplicationCut(object sender, ExecutedRoutedEventArgs e)
Parameters
System.Object sender

System.Windows.Input.ExecutedRoutedEventArgs e

OnApplicationPaste(Object, ExecutedRoutedEventArgs)

Occurs when paste operation is performed.

Declaration
protected virtual void OnApplicationPaste(object sender, ExecutedRoutedEventArgs e)
Parameters
System.Object sender

System.Windows.Input.ExecutedRoutedEventArgs e

OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes call System.Windows.FrameworkElement.ApplyTemplate.

Declaration
public override void OnApplyTemplate()

OnCreateAutomationPeer()

Create the TimeSpanPicker Automation Peer.

Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
System.Windows.Automation.Peers.AutomationPeer

OnGotFocus(RoutedEventArgs)

Invoked whenever an unhandled System.Windows.UIElement.GotFocus event reaches this element in its route.

Declaration
protected override void OnGotFocus(RoutedEventArgs e)
Parameters
System.Windows.RoutedEventArgs e

OnInitialized(EventArgs)

Raises the System.Windows.FrameworkElement.Initialized event. This method is invoked whenever System.Windows.FrameworkElement.IsInitialized is set to true internally.

Declaration
protected override void OnInitialized(EventArgs e)
Parameters
System.EventArgs e

The System.Windows.RoutedEventArgs that contains the event data.

OnKeyUp(KeyEventArgs)

Invoked when an unhandled System.Windows.Input.Keyboard.KeyUp attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Declaration
protected override void OnKeyUp(KeyEventArgs e)
Parameters
System.Windows.Input.KeyEventArgs e

OnMouseWheel(MouseWheelEventArgs)

Declaration
protected override void OnMouseWheel(MouseWheelEventArgs e)
Parameters
System.Windows.Input.MouseWheelEventArgs e

OnValueEditing(Nullable<TimeSpan>, EditSection, Nullable<Decimal>, Nullable<Char>, Boolean, SpinAction)

Occurs when the Value property is being changed after editing operation.

Declaration
protected virtual bool OnValueEditing(Nullable<TimeSpan> newValue, EditSection section, Nullable<Decimal> oldSectionValue, Nullable<char> digitChar = null, bool isDelete = false, SpinAction spinAction)
Parameters
System.Nullable<System.TimeSpan> newValue

The new value to be set.
EditSection section

The section that is edited.
System.Nullable<System.Decimal> oldSectionValue

The value of the section before edit.
System.Nullable<System.Char> digitChar

The char to be inserted in the section.
System.Boolean isDelete

The char to be inserted in the section.
SpinAction spinAction

Indicates the spin action type.
Returns
System.Boolean

ResetTheme()

Resets the theme.

Declaration
public void ResetTheme()

Events

DropDownClosed

Occurs when the DropDownButton is closed.

Declaration
public event RoutedEventHandler DropDownClosed
Event Type
System.Windows.RoutedEventHandler

DropDownOpened

Occurs when the DropDownButton is opened.

Declaration
public event RoutedEventHandler DropDownOpened
Event Type
System.Windows.RoutedEventHandler

ValueChanged

Occurs when the Value property is changed.

Declaration
public event EventHandler<ValueChangedEventArgs> ValueChanged
Event Type
System.EventHandler<ValueChangedEventArgs>

ValueEditing

Occurs when the Value property is about to change on edit operation via textbox or dropdown popup.

Declaration
public event EventHandler<ValueEditingEventArgs> ValueEditing
Event Type
System.EventHandler<ValueEditingEventArgs>

Extension Methods