Class RadTimePicker

Represents a control that allows the user to select a time and to display the time with a specified format.

Inheritance
System.Object
RadControl
RadEditorControl
RadTimePicker
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

[TelerikToolboxCategory("Editors")]
public class RadTimePicker : RadEditorControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider

Constructors

RadTimePicker()

Initializes a new instance of the RadTimePicker class with default settings.

Declaration
public RadTimePicker()

Properties

AutoSize

Gets or sets a value indicating whether the edit control is automatically resized to display its entire contents.

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

true if the control automatically resizes; otherwise, false. The default value is true.
Overrides

ButtonPanelHeight

Gets or sets the height of the button panel in the time picker popup.

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

An integer representing the button panel height in pixels. The default value is 35.

ClockPosition

Gets or sets the position of the clock relative to the time tables in the time picker popup.

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

A ClockPosition enumeration value specifying the clock position. The default value is ClockBeforeTables.

CloseButtonText

Gets or sets the text displayed on the close button in the time picker popup.

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

A string containing the text for the close button. The default value is "Close".

ColumnsCount

Gets or sets the number of columns displayed in the time picker popup.

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

An integer representing the number of columns. Valid values are between 4 and 12. The default value is 4.

Culture

Gets or sets the culture information used to format and parse time values in the time picker.

Declaration
public CultureInfo Culture { get; set; }
Property Value
System.Globalization.CultureInfo

A System.Globalization.CultureInfo object that represents the culture to use for time formatting.

DefaultSize

Gets the default size of the control.

Declaration
protected override Size DefaultSize { get; }
Property Value
System.Drawing.Size

HeadersHeight

Gets or sets the height of the header section in the time picker popup.

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

An integer representing the header height in pixels. The default value is 19.

MaxValue

Gets or sets the Maximal time value assigned to the control.

Declaration
public DateTime MaxValue { get; set; }
Property Value
System.DateTime

MinValue

Gets or sets the Minimal time value assigned to the control.

Declaration
public DateTime MinValue { get; set; }
Property Value
System.DateTime

NullText

Gets or sets the text that is displayed when RadDropDownList has no text set.

Declaration
[RadDefaultValue("NullText", typeof(RadTextBoxItem))]
[RadDescription("NullText", typeof(RadTextBoxItem))]
public string NullText { get; set; }
Property Value
System.String

ReadOnly

Gets or sets a value indicating whether the contents of the TextBox control can be changed.

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

RowHeight

Gets or sets the height of each time row in the time picker popup.

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

An integer representing the row height in pixels. The default value is 29.

Step

Gets or sets the time interval step for the time picker in minutes.

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

An integer representing the time step in minutes. Valid values are between 1 and 59. The default value is 5.

TableWidth

Gets or sets the width of the time table in the time picker popup.

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

An integer representing the table width in pixels. The default value is 170.

Text

This property is not relevant for this class.

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

Overrides

TimePickerElement

Gets the RadTimePickerElement which encapsulates the UI representation and functionality of the control.

Declaration
public RadTimePickerElement TimePickerElement { get; }
Property Value
RadTimePickerElement

TimeTables

Gets or sets the configuration of time tables displayed in the time picker popup.

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

A TimeTables enumeration value that determines how time is represented. The default value is HoursAndMinutesInTwoTables.

Value

Gets or sets the time value assigned to the control.

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

Methods

CreateChildItems(RadElement)

Creates the child elements for the RadTimePicker control.

Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
RadElement parent

The root element that will contain the child elements.
Overrides

CreateTimePickerElement()

Creates the RadTimePickerElement that serves as the main element for this control.

Declaration
protected virtual RadTimePickerElement CreateTimePickerElement()
Returns
RadTimePickerElement

A new instance of RadTimePickerElement.

Dispose(Boolean)

Disposes of the resources (other than memory) used by the System.Windows.Forms.Control.

Declaration
protected override void Dispose(bool disposing)
Parameters
System.Boolean disposing

true to release both managed and unmanaged resources, false to release only unmanaged resources.
Overrides

OnKeyDown(Object, KeyEventArgs)

Raises the KeyDown event.

Declaration
public virtual void OnKeyDown(object sender, KeyEventArgs e)
Parameters
System.Object sender

The source of the event.
System.Windows.Forms.KeyEventArgs e

A System.Windows.Forms.KeyEventArgs that contains the event data.

OnKeyPress(Object, KeyPressEventArgs)

Raises the KeyPress event.

Declaration
public virtual void OnKeyPress(object sender, KeyPressEventArgs e)
Parameters
System.Object sender

The source of the event.
System.Windows.Forms.KeyPressEventArgs e

A System.Windows.Forms.KeyPressEventArgs that contains the event data.

OnKeyUp(Object, KeyEventArgs)

Raises the KeyUp event.

Declaration
public virtual void OnKeyUp(object sender, KeyEventArgs e)
Parameters
System.Object sender

The source of the event.
System.Windows.Forms.KeyEventArgs e

A System.Windows.Forms.KeyEventArgs that contains the event data.

OnMultilineChanged(Object, EventArgs)

Raises the MultilineChanged event.

Declaration
public virtual void OnMultilineChanged(object sender, EventArgs e)
Parameters
System.Object sender

The source of the event.
System.EventArgs e

An object that contains no event data.

OnRightToLeftChanged(EventArgs)

Occurs when right to left property is changed.

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

The event arguments.
Overrides

OnSizeChanged(EventArgs)

Raises the System.Windows.Forms.Control.SizeChanged event.

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

An event args the contain the event data.

OnTextAlignChanged(Object, EventArgs)

Raises the TextAlignChanged event.

Declaration
public virtual void OnTextAlignChanged(object sender, EventArgs e)
Parameters
System.Object sender

The source of the event.
System.EventArgs e

An object that contains no event data.

OnValueChanged(Object, EventArgs)

Raises the ValueChanged event.

Declaration
protected virtual void OnValueChanged(object sender, EventArgs e)
Parameters
System.Object sender

The source of the event.
System.EventArgs e

An object that contains no event data.

OnValueChanging(Object, CancelEventArgs)

Raises the ValueChanging event.

Declaration
protected virtual void OnValueChanging(object sender, CancelEventArgs e)
Parameters
System.Object sender

The source of the event.
System.ComponentModel.CancelEventArgs e

A System.ComponentModel.CancelEventArgs that contains the event data.

ProcessAutoSizeChanged(Boolean)

Occurs when the AutoSize property value is about to be changed. Usually used to synchronize the stretch modes of the root element.

Declaration
protected override void ProcessAutoSizeChanged(bool value)
Parameters
System.Boolean value

The new auto-size value.
Overrides

ResetBackColorThemeOverrides()

Occurs when the System.Windows.Forms.Control.BackColor property is reset and is used to reset overridden theme settings in the elements hierarchy.

Declaration
protected override void ResetBackColorThemeOverrides()
Overrides

ResetForeColorThemeOverrides()

Occurs when the System.Windows.Forms.Control.ForeColor property is reset and is used to reset overridden theme settings in the elements hierarchy.

Declaration
protected override void ResetForeColorThemeOverrides()
Overrides

SetBackColorThemeOverrides()

Occurs when the System.Windows.Forms.Control.BackColor property is changed and is used to override theme settings in the elements hierarchy.

Declaration
protected override void SetBackColorThemeOverrides()
Overrides

SetForeColorThemeOverrides()

Occurs when the System.Windows.Forms.Control.ForeColor property is changed and is used to override theme settings in the elements hierarchy.

Declaration
protected override void SetForeColorThemeOverrides()
Overrides

UnwireEvents()

Detaches from all events of its sub-elements.

Declaration
protected void UnwireEvents()

WireEvents()

Attaches to all events of its sub-elements.

Declaration
protected void WireEvents()

WndProc(ref Message)

Processes windows messages.

Declaration
protected override void WndProc(ref Message m)
Parameters
System.Windows.Forms.Message m

The windows message to process.
Overrides

Events

KeyDown

Occurs when the RadItem has focus and the user presses a key down

Declaration
public event KeyEventHandler KeyDown
Event Type
System.Windows.Forms.KeyEventHandler

KeyPress

Occurs when the RadItem has focus and the user presses a key

Declaration
public event KeyPressEventHandler KeyPress
Event Type
System.Windows.Forms.KeyPressEventHandler

KeyUp

Occurs when the RadItem has focus and the user releases the pressed key up

Declaration
public event KeyEventHandler KeyUp
Event Type
System.Windows.Forms.KeyEventHandler

MultilineChanged

Occurs when the value of the Multiline property has changed.

Declaration
public event EventHandler MultilineChanged
Event Type
System.EventHandler

TextAlignChanged

Occurs when the value of the TextAlign property has changed.

Declaration
public event EventHandler TextAlignChanged
Event Type
System.EventHandler

TimeCellFormatting

Occurs when a cell changes its state.

Declaration
public event TimeCellFormattingEventHandler TimeCellFormatting
Event Type
TimeCellFormattingEventHandler

ValueChanged

Occurs when the editing value has been changed

Declaration
public event EventHandler ValueChanged
Event Type
System.EventHandler

ValueChanging

Occurs when the editing value is changing.

Declaration
public event CancelEventHandler ValueChanging
Event Type
System.ComponentModel.CancelEventHandler

Extension Methods