ClassRadTimePicker
Represents a control that allows the user to select a time and to display the time with a specified format.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
[TelerikToolboxCategory("Editors")]
public class RadTimePicker : RadEditorControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProvider
Inheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadEditorControlRadTimePicker
Implements:
Inherited Members
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
[Browsable(true)]
public override bool AutoSize { get; set; }
Property Value
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
[Browsable(false)]
public int ButtonPanelHeight { get; set; }
Property Value
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
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
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
[Browsable(false)]
public int ColumnsCount { get; set; }
Property Value
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
A 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
Overrides
HeadersHeight
Gets or sets the height of the header section in the time picker popup.
Declaration
[Browsable(false)]
public int HeadersHeight { get; set; }
Property Value
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
[Browsable(true)]
public DateTime MaxValue { get; set; }
Property Value
MinValue
Gets or sets the Minimal time value assigned to the control.
Declaration
[Browsable(true)]
public DateTime MinValue { get; set; }
Property Value
NullText
Gets or sets the text that is displayed when RadDropDownList has no text set.
ReadOnly
Gets or sets a value indicating whether the contents of the TextBox control can be changed.
RowHeight
Gets or sets the height of each time row in the time picker popup.
Declaration
[Browsable(false)]
public int RowHeight { get; set; }
Property Value
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
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
[Browsable(false)]
public int TableWidth { get; set; }
Property Value
An integer representing the table width in pixels. The default value is 170.
TimePickerElement
Gets the RadTimePickerElement which encapsulates the UI representation and functionality of the control.
Declaration
[Browsable(false)]
public RadTimePickerElement TimePickerElement { get; }
Property Value
TimeTables
Gets or sets the configuration of time tables displayed in the time picker popup.
Declaration
public TimeTables TimeTables { get; set; }
Property Value
A TimeTables enumeration value that determines how time is represented. The default value is HoursAndMinutesInTwoTables.
Methods
CreateChildItems(RadElement)
Creates the child elements for the RadTimePicker control.
Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
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
A new instance of RadTimePickerElement.
Dispose(bool)
Disposes of the resources (other than memory) used by the Control.
Declaration
protected override void Dispose(bool disposing)
Parameters
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
sender
The source of the event.
e
A KeyEventArgs that contains the event data.
OnKeyPress(object, KeyPressEventArgs)
Raises the KeyPress event.
Declaration
public virtual void OnKeyPress(object sender, KeyPressEventArgs e)
Parameters
sender
The source of the event.
e
A KeyPressEventArgs that contains the event data.
OnKeyUp(object, KeyEventArgs)
Raises the KeyUp event.
Declaration
public virtual void OnKeyUp(object sender, KeyEventArgs e)
Parameters
sender
The source of the event.
e
A KeyEventArgs that contains the event data.
OnMultilineChanged(object, EventArgs)
Raises the MultilineChanged event.
OnRightToLeftChanged(EventArgs)
Occurs when right to left property is changed.
Declaration
protected override void OnRightToLeftChanged(EventArgs e)
Parameters
e
The event arguments.
Overrides
OnSizeChanged(EventArgs)
Raises the SizeChanged event.
Declaration
protected override void OnSizeChanged(EventArgs e)
Parameters
e
An event args the contain the event data.
Overrides
OnTextAlignChanged(object, EventArgs)
Raises the TextAlignChanged event.
OnValueChanged(object, EventArgs)
Raises the ValueChanged event.
OnValueChanging(object, CancelEventArgs)
Raises the ValueChanging event.
Declaration
protected virtual void OnValueChanging(object sender, CancelEventArgs e)
Parameters
sender
The source of the event.
e
A CancelEventArgs that contains the event data.
ProcessAutoSizeChanged(bool)
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
value
The new auto-size value.
Overrides
ResetBackColorThemeOverrides()
Occurs when the 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 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 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 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
m
The windows message to process.
Overrides
Events
KeyDown
Occurs when the RadItem has focus and the user presses a key down
KeyPress
Occurs when the RadItem has focus and the user presses a key
Declaration
public event KeyPressEventHandler KeyPress
Event Value
KeyUp
Occurs when the RadItem has focus and the user releases the pressed key up
MultilineChanged
<span id="ctl00_ContentPlaceHolder1_src1_resRC_ctl02_LabelAbstract">Occurs when
the value of the Multiline property has changed.
Declaration
[Browsable(true)]
public event EventHandler MultilineChanged
Event Value
TextAlignChanged
<span id="ctl00_ContentPlaceHolder1_src1_resRC_ctl03_LabelAbstract">Occurs when
the value of the TextAlign property has changed.
Declaration
[Browsable(true)]
public event EventHandler TextAlignChanged
Event Value
TimeCellFormatting
Occurs when a cell changes its state.
Declaration
public event TimeCellFormattingEventHandler TimeCellFormatting
Event Value
ValueChanged
Occurs when the editing value has been changed
ValueChanging
Occurs when the editing value is changing.
Declaration
public event CancelEventHandler ValueChanging
Event Value