ClassRadTimePickerElement
Represents the main element of the RadTimePicker control. It hosts all child elements and provides the core functionality for time selection, popup management, and user interaction.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
public class RadTimePickerElement : PopupEditorBaseElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IBindableComponent, IComponent, IDisposable, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IInputEditor, IValueEditor, ISupportInitialize, IPickerContentElementOwner
Inheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemRadEditorElementEditorBaseElementPopupEditorBaseElementRadTimePickerElement
Implements:
Inherited Members
Constructors
RadTimePickerElement()
Initializes a new instance of the RadTimePickerElement class with default settings.
Declaration
public RadTimePickerElement()
Fields
IsDropDownShownProperty
Identifies the IsDropDownShown dependency property that indicates whether the time picker popup is currently displayed.
Declaration
public static RadProperty IsDropDownShownProperty
Field Value
PopupMinSizeProperty
Identifies the PopupMinSize dependency property that specifies the minimum size constraints for the time picker popup.
Declaration
public static RadProperty PopupMinSizeProperty
Field Value
Properties
ButtonPanelHeight
Gets or sets the button panel height.
ClockPosition
Determines the click position.
Declaration
public ClockPosition ClockPosition { get; set; }
Property Value
ColumnsCount
Gets or sets the column count.
Culture
Gets or sets the culture.
Declaration
public CultureInfo Culture { get; set; }
Property Value
Implements
DownButton
Gets the down arrow button.
Declaration
public RadRepeatArrowElement DownButton { get; }
Property Value
DropDownAnimationEnabled
Gets or sets a value indicating whether the RadDropDownList will be animated when displaying.
Declaration
public bool DropDownAnimationEnabled { get; set; }
Property Value
DropDownButton
Gets the drop-down button.
Declaration
public RadTimeDropDownButtonElement DropDownButton { get; }
Property Value
EditorElement
Gets or sets the editor element.
Declaration
public override RadItem EditorElement { get; set; }
Property Value
Overrides
Format
Gets or sets the format string.
HeadersHeight
Gets or sets the headers height.
HourHeaderText
Gets the hours header text.
Declaration
public string HourHeaderText { get; set; }
Property Value
Implements
MaskedEditBox
Gets the masked edit box.
Declaration
public virtual RadMaskedEditBoxElement MaskedEditBox { get; }
Property Value
MaxValue
Gets or sets the maximum value.
MinValue
Gets or sets the minimum value.
MinutesHeaderText
Gets the minutes header text.
Declaration
public virtual string MinutesHeaderText { get; set; }
Property Value
Implements
NullText
Gets or sets the text that is displayed when RadDropDownList has no text set.
PopupContentElement
Gets the pop-up content element.
Declaration
public virtual RadTimePickerContentElement PopupContentElement { get; }
Property Value
PopupForm
Gets the pop-up form.
Declaration
public RadTimePickerPopup PopupForm { get; }
Property Value
PopupMinSize
Determines the minimum size of the pop-up.
ReadOnly
Enables or disables the ReadOnly mode of RadTimeBox. The default value is false.
Declaration
[Browsable(false)]
public bool ReadOnly { get; set; }
Property Value
RowHeight
Gets or sets the row height.
ShowSpinButtons
Indicates whether to show the spin buttons.
SpinButtonsStackLayout
Gets the StackLayoutElement that contains the spin buttons.
Declaration
public StackLayoutElement SpinButtonsStackLayout { get; }
Property Value
Step
Gets or sets the step.
TableWidth
Gets or sets the table width.
TimeTables
Gets or sets a value indicating how the time tables will be displayed.
TwoTablesForTime
Determines whether to use two tables for hours and minutes or display them into a single table.
UpButton
Gets the up arrow button.
Declaration
public RadRepeatArrowElement UpButton { get; }
Property Value
Methods
CloseOwnerPopup()
Closes the pop-up.
Declaration
public void CloseOwnerPopup()
Implements
CreateArrowButtonElement()
Creates the arrow button element.
Declaration
protected virtual void CreateArrowButtonElement()
CreateChildElements()
Called by the element when constructed. Allows inheritors to build the element tree.
Declaration
protected override void CreateChildElements()
Overrides
CreateDownButton()
Creates the button element for the decrement button.
Declaration
protected virtual RadRepeatArrowElement CreateDownButton()
Returns
A RadRepeatArrowElement to be placed in the RadSpinElement.
CreatePopupForm()
Creates and configures the popup form that displays the time selection interface.
Declaration
protected override RadPopupControlBase CreatePopupForm()
Returns
A RadPopupControlBase instance representing the time picker popup.
Overrides
CreateSpinButtons()
Creates the spin buttons and the container.
Declaration
protected virtual void CreateSpinButtons()
CreateTextEditorElement()
Creates the text editor element used for time input and display.
Declaration
protected virtual void CreateTextEditorElement()
CreateUpButton()
Creates the button element for the increment button.
Declaration
protected virtual RadRepeatArrowElement CreateUpButton()
Returns
A RadRepeatArrowElement to be placed in the RadSpinElement.
DisposeManagedResources()
Releases the managed resources.
Declaration
protected override void DisposeManagedResources()
Overrides
GetInitialPopupSize()
Gets the initial size of the pop-up.
GetPopupSize(RadPopupControlBase, bool)
Gets the size of the pop-up.
Declaration
protected override Size GetPopupSize(RadPopupControlBase popup, bool measure)
Parameters
popup
The pop-up.
measure
Not used.
Returns
The size of the pop-up.
Overrides
MaskEditBox_Click(object, EventArgs)
Called when the mask edit box is clicked.
MaskEditBox_KeyDown(object, KeyEventArgs)
Called when a key is pressed down while the mask edit box has focus.
Declaration
protected virtual void MaskEditBox_KeyDown(object sender, KeyEventArgs e)
Parameters
sender
The source of the event.
e
A KeyEventArgs that contains the event data.
MaskEditBox_KeyPress(object, KeyPressEventArgs)
Called when a key is pressed while the mask edit box has focus.
Declaration
protected virtual void MaskEditBox_KeyPress(object sender, KeyPressEventArgs e)
Parameters
sender
The source of the event.
e
A KeyPressEventArgs that contains the event data.
MaskEditBox_MouseUp(object, MouseEventArgs)
Called when the mouse pointer is over the mask edit box and a mouse button is released.
Declaration
protected virtual void MaskEditBox_MouseUp(object sender, MouseEventArgs e)
Parameters
sender
The source of the event.
e
A MouseEventArgs that contains the event data.
MaskEditBox_MouseWheel(object, MouseEventArgs)
Called when the mouse wheel moves while the mask edit box has focus.
Declaration
protected virtual void MaskEditBox_MouseWheel(object sender, MouseEventArgs e)
Parameters
sender
The source of the event.
e
A MouseEventArgs that contains the event data.
MeasureOverride(SizeF)
Measures the space required by the RadElement
Used by the layout system.
Declaration
protected override SizeF MeasureOverride(SizeF availableSize)
Parameters
availableSize
The size that is available to the RadElement. The available size can be infinity (to take the full size of the element)
Returns
The minimum size required by the element to be completely visible. Cannot be infinity.
Overrides
Remarks
In this method call to the Measure method of each child must be made.
OnLoaded()
Called when the element has been successfully loaded. That includes loading of all its children as well.
Declaration
protected override void OnLoaded()
Overrides
OnPopupClosed(object, RadPopupClosedEventArgs)
Called when the pop-up is closed.
Declaration
protected virtual void OnPopupClosed(object sender, RadPopupClosedEventArgs args)
Parameters
sender
The source of the event.
args
A RadPopupClosedEventArgs that contains the event data.
OnPopupClosing(object, RadPopupClosingEventArgs)
Called when the pop-up is about to be closed. Cancellable.
Declaration
protected virtual void OnPopupClosing(object sender, RadPopupClosingEventArgs args)
Parameters
sender
The source of the event.
args
A RadPopupClosingEventArgs that contains the event data.
OnPopupOpened(object, EventArgs)
Called when the pop-up is opened.
OnPropertyChanged(RadPropertyChangedEventArgs)
Called when a RadProperty value of this instance is changed.
Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
e
A RadPropertyChangedEventArgs that contains the event data.
Overrides
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.
UnwireEvents()
Detaches from all events of its sub-elements.
Declaration
protected virtual void UnwireEvents()
UpdateHeadersText()
Updates all header texts.
Declaration
protected virtual void UpdateHeadersText()
WireEvents()
Attaches to all necessary events of its sub-elements.
Declaration
protected virtual void WireEvents()
arrowButton_Click(object, EventArgs)
Called when the arrow button is clicked.
Events
Click
Occurs when the control is clicked.
KeyDown
Occurs when a key is pressed down while the control has focus.
KeyPress
Occurs when a key is pressed while the control has focus.
Declaration
public event KeyPressEventHandler KeyPress
Event Value
KeyUp
Occurs when a key is released while the control has focus.
MouseUp
Occurs when the mouse pointer is over the control and a mouse button is released.
MouseWheel
Occurs when the mouse wheel moves while the control has focus.
Declaration
public event MouseEventHandler MouseWheel
Event Value
TimeCellFormatting
Occurs when the content of a time cell needs to be formatted for display.
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