Class
RadTimeSpanPicker

Represents a control that allows the user to select TimeSpans.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.Input.dll

Syntax:

cs-api-definition
[TelerikToolboxCategory("Input")]
[SuppressMessage("Design", "CA1001:Types that own disposable fields should be disposable", Justification = "<Pending>")]
public class RadTimeSpanPicker : Control

Inheritance: objectRadTimeSpanPicker

Constructors

RadTimeSpanPicker()

Initializes a new instance of the RadTimeSpanPicker class.

Declaration

cs-api-definition
public RadTimeSpanPicker()

Fields

DropDownWidthProperty

Identifies the DropDownWidth dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty DropDownWidthProperty

Field Value

DependencyProperty

EditModeProperty

Identifies the EditMode dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty EditModeProperty

Field Value

DependencyProperty

GenerateDefaultComponentsProperty

Identifies the GenerateDefaultComponents dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty GenerateDefaultComponentsProperty

Field Value

DependencyProperty

IsDropDownOpenProperty

Identifies the IsDropDownOpen dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsDropDownOpenProperty

Field Value

DependencyProperty

MaxDropDownHeightProperty

Identifies the MaxDropDownHeight dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty MaxDropDownHeightProperty

Field Value

DependencyProperty

SpinModeProperty

Identifies the SpinMode dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty SpinModeProperty

Field Value

DependencyProperty

StringFormatProperty

Identifies the StringFormat dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty StringFormatProperty

Field Value

DependencyProperty

TabNavigationModeProperty

Identifies the TabNavigationMode dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty TabNavigationModeProperty

Field Value

DependencyProperty

TextAlignmentProperty

Identifies the TextAlignment dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty TextAlignmentProperty

Field Value

DependencyProperty

TimeSpanComponentStyleProperty

Identifies the TimeSpanComponentStyle dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty TimeSpanComponentStyleProperty

Field Value

DependencyProperty

TimeSpanComponentStyleSelectorProperty

Identifies the TimeSpanComponentStyleSelector dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty TimeSpanComponentStyleSelectorProperty

Field Value

DependencyProperty

TimeSpanComponentsProperty

Identifies the TimeSpanComponents read-only dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty TimeSpanComponentsProperty

Field Value

DependencyProperty

TimeSpanTextProperty

Identifies the TimeSpanText dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty TimeSpanTextProperty

Field Value

DependencyProperty

TimeSpanWatermarkContentProperty

Identifies the TimeSpanWatermarkContent dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty TimeSpanWatermarkContentProperty

Field Value

DependencyProperty

TimeSpanWatermarkTemplateProperty

Identifies the TimeSpanWatermarkTemplate dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty TimeSpanWatermarkTemplateProperty

Field Value

DependencyProperty

ValueProperty

Identifies the Value dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ValueProperty

Field Value

DependencyProperty

Properties

DropDownWidth

Gets or sets the width for a RadTimeSpanPicker DropDown.

Declaration

cs-api-definition
public double DropDownWidth { get; set; }

Property Value

double

EditMode

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

Declaration

cs-api-definition
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

cs-api-definition
public bool GenerateDefaultComponents { get; set; }

Property Value

bool

IsDropDownOpen

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

Declaration

cs-api-definition
public bool IsDropDownOpen { get; set; }

Property Value

bool

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

MaxDropDownHeight

Gets or sets the maximum height for a RadTimeSpanPicker DropDown.

Declaration

cs-api-definition
public double MaxDropDownHeight { get; set; }

Property Value

double

SpinMode

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

Declaration

cs-api-definition
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

cs-api-definition
public string StringFormat { get; set; }

Property Value

string

TabNavigationMode

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

Declaration

cs-api-definition
public TabNavigationMode TabNavigationMode { get; set; }

Property Value

TabNavigationMode

TextAlignment

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

Declaration

cs-api-definition
public TextAlignment TextAlignment { get; set; }

Property Value

TextAlignment

The TextAlignment of the TextBox.

TimeSpanComponentStyle

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

Declaration

cs-api-definition
public Style TimeSpanComponentStyle { get; set; }

Property Value

Style

TimeSpanComponentStyleSelector

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

Declaration

cs-api-definition
public StyleSelector TimeSpanComponentStyleSelector { get; set; }

Property Value

StyleSelector

TimeSpanComponents

Gets the TimeSpanComponentCollection that is currently used in the RadTimeSpanPicker.

Declaration

cs-api-definition
public TimeSpanComponentCollection TimeSpanComponents { get; }

Property Value

TimeSpanComponentCollection

TimeSpanText

Gets the formatted string representing the Value.

Declaration

cs-api-definition
public string TimeSpanText { get; }

Property Value

string

TimeSpanWatermarkContent

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

Declaration

cs-api-definition
public object TimeSpanWatermarkContent { get; set; }

Property Value

object

TimeSpanWatermarkTemplate

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

Declaration

cs-api-definition
public DataTemplate TimeSpanWatermarkTemplate { get; set; }

Property Value

DataTemplate

Value

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

Declaration

cs-api-definition
public TimeSpan? Value { get; set; }

Property Value

TimeSpan?

Methods

OnApplicationCut(object, ExecutedRoutedEventArgs)

Occurs when cut operation is executed.

Declaration

cs-api-definition
protected virtual void OnApplicationCut(object sender, ExecutedRoutedEventArgs e)

Parameters

sender

object

e

ExecutedRoutedEventArgs

OnApplicationPaste(object, ExecutedRoutedEventArgs)

Occurs when paste operation is performed.

Declaration

cs-api-definition
protected virtual void OnApplicationPaste(object sender, ExecutedRoutedEventArgs e)

Parameters

sender

object

e

ExecutedRoutedEventArgs

OnApplyTemplate()

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

Declaration

cs-api-definition
public override void OnApplyTemplate()

OnCreateAutomationPeer()

Create the TimeSpanPicker Automation Peer.

Declaration

cs-api-definition
protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer

OnGotFocus(RoutedEventArgs)

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

Declaration

cs-api-definition
protected override void OnGotFocus(RoutedEventArgs e)

Parameters

e

RoutedEventArgs

OnInitialized(EventArgs)

Raises the event. This method is invoked whenever is set to true internally.

Declaration

cs-api-definition
protected override void OnInitialized(EventArgs e)

Parameters

e

EventArgs

The 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

cs-api-definition
protected override void OnKeyUp(KeyEventArgs e)

Parameters

e

KeyEventArgs

OnMouseWheel(MouseWheelEventArgs)

Declaration

cs-api-definition
protected override void OnMouseWheel(MouseWheelEventArgs e)

Parameters

e

MouseWheelEventArgs

OnValueEditing(TimeSpan?, EditSection, decimal?, char?, bool, SpinAction)

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

Declaration

cs-api-definition
protected virtual bool OnValueEditing(TimeSpan? newValue, EditSection section, decimal? oldSectionValue, char? digitChar = null, bool isDelete = false, SpinAction spinAction = SpinAction.None)

Parameters

newValue

TimeSpan?

The new value to be set.

section

EditSection

The section that is edited.

oldSectionValue

decimal?

The value of the section before edit.

digitChar

char?

The char to be inserted in the section.

isDelete

bool

The char to be inserted in the section.

spinAction

SpinAction

Indicates the spin action type.

Returns

bool

ResetTheme()

Resets the theme.

Declaration

cs-api-definition
public void ResetTheme()

Events

DropDownClosed

Occurs when the DropDownButton is closed.

Declaration

cs-api-definition
public event RoutedEventHandler DropDownClosed

Event Value

RoutedEventHandler

DropDownOpened

Occurs when the DropDownButton is opened.

Declaration

cs-api-definition
public event RoutedEventHandler DropDownOpened

Event Value

RoutedEventHandler

ValueChanged

Occurs when the Value property is changed.

Declaration

cs-api-definition
public event EventHandler<ValueChangedEventArgs> ValueChanged

Event Value

EventHandler<ValueChangedEventArgs>

ValueEditing

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

Declaration

cs-api-definition
public event EventHandler<ValueEditingEventArgs> ValueEditing

Event Value

EventHandler<ValueEditingEventArgs>