RadTimePickerElement
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
Initializes a new instance of the RadTimePickerElement class with default settings.
public RadTimePickerElement()
Fields
Identifies the IsDropDownShown dependency property that indicates whether the time picker popup is currently displayed.
public static RadProperty IsDropDownShownProperty
Identifies the PopupMinSize dependency property that specifies the minimum size constraints for the time picker popup.
public static RadProperty PopupMinSizeProperty
Properties
Gets or sets the button panel height.
public int ButtonPanelHeight { get; set; }
Determines the click position.
public ClockPosition ClockPosition { get; set; }
Gets or sets the column count.
public int ColumnsCount { get; set; }
Gets or sets the culture.
public CultureInfo Culture { get; set; }
Implements:
Gets the down arrow button.
public RadRepeatArrowElement DownButton { get; }
Gets or sets a value indicating whether the RadDropDownList will be animated when displaying.
public bool DropDownAnimationEnabled { get; set; }
Gets the drop-down button.
public RadTimeDropDownButtonElement DropDownButton { get; }
Gets or sets the editor element.
public override RadItem EditorElement { get; set; }
Overrides:
Gets or sets the headers height.
public int HeadersHeight { get; set; }
Gets the hours header text.
public string HourHeaderText { get; set; }
Implements:
Gets the masked edit box.
public virtual RadMaskedEditBoxElement MaskedEditBox { get; }
Gets the minutes header text.
public virtual string MinutesHeaderText { get; set; }
Implements:
Gets or sets the text that is displayed when RadDropDownList has no text set.
public string NullText { get; set; }
Gets the pop-up content element.
public virtual RadTimePickerContentElement PopupContentElement { get; }
Gets the pop-up form.
public RadTimePickerPopup PopupForm { get; }
Determines the minimum size of the pop-up.
public Size PopupMinSize { get; set; }
Enables or disables the ReadOnly mode of RadTimeBox. The default value is false.
[Browsable(false)]
public bool ReadOnly { get; set; }
Indicates whether to show the spin buttons.
public bool ShowSpinButtons { get; set; }
Gets the StackLayoutElement that contains the spin buttons.
public StackLayoutElement SpinButtonsStackLayout { get; }
Gets or sets the table width.
public int TableWidth { get; set; }
Gets or sets a value indicating how the time tables will be displayed.
public TimeTables TimeTables { get; set; }
Determines whether to use two tables for hours and minutes or display them into a single table.
public bool TwoTablesForTime { get; set; }
Gets the up arrow button.
public RadRepeatArrowElement UpButton { get; }
Methods
Closes the pop-up.
public void CloseOwnerPopup()
Implements:
Creates the arrow button element.
protected virtual void CreateArrowButtonElement()
Called by the element when constructed. Allows inheritors to build the element tree.
protected override void CreateChildElements()
Overrides:
Creates the button element for the decrement button.
protected virtual RadRepeatArrowElement CreateDownButton()
A RadRepeatArrowElement to be placed in the RadSpinElement.
Creates and configures the popup form that displays the time selection interface.
protected override RadPopupControlBase CreatePopupForm()
A RadPopupControlBase instance representing the time picker popup.
Overrides:
Creates the spin buttons and the container.
protected virtual void CreateSpinButtons()
Creates the text editor element used for time input and display.
protected virtual void CreateTextEditorElement()
Creates the button element for the increment button.
protected virtual RadRepeatArrowElement CreateUpButton()
A RadRepeatArrowElement to be placed in the RadSpinElement.
Releases the managed resources.
protected override void DisposeManagedResources()
Overrides:
Gets the initial size of the pop-up.
Gets the size of the pop-up.
protected override Size GetPopupSize(RadPopupControlBase popup, bool measure)
The pop-up.
measureboolNot used.
Returns:The size of the pop-up.
Overrides:
Called when a key is pressed down while the mask edit box has focus.
protected virtual void MaskEditBox_KeyDown(object sender, KeyEventArgs e)
The source of the event.
eKeyEventArgsA KeyEventArgs that contains the event data.
Called when a key is pressed while the mask edit box has focus.
protected virtual void MaskEditBox_KeyPress(object sender, KeyPressEventArgs e)
The source of the event.
eKeyPressEventArgsA KeyPressEventArgs that contains the event data.
Called when the mouse pointer is over the mask edit box and a mouse button is released.
protected virtual void MaskEditBox_MouseUp(object sender, MouseEventArgs e)
The source of the event.
eMouseEventArgsA MouseEventArgs that contains the event data.
Called when the mouse wheel moves while the mask edit box has focus.
protected virtual void MaskEditBox_MouseWheel(object sender, MouseEventArgs e)
The source of the event.
eMouseEventArgsA MouseEventArgs that contains the event data.
Measures the space required by the RadElement
Used by the layout system.
protected override SizeF MeasureOverride(SizeF 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:
In this method call to the Measure method of each child must be made.
Called when the element has been successfully loaded. That includes loading of all its children as well.
protected override void OnLoaded()
Overrides:
Called when the pop-up is closed.
protected virtual void OnPopupClosed(object sender, RadPopupClosedEventArgs args)
The source of the event.
argsRadPopupClosedEventArgsA RadPopupClosedEventArgs that contains the event data.
Called when the pop-up is about to be closed. Cancellable.
protected virtual void OnPopupClosing(object sender, RadPopupClosingEventArgs args)
The source of the event.
argsRadPopupClosingEventArgsA RadPopupClosingEventArgs that contains the event data.
Called when a RadProperty value of this instance is changed.
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
A RadPropertyChangedEventArgs that contains the event data.
Overrides:
Raises the ValueChanged event.
Raises the ValueChanging event.
protected virtual void OnValueChanging(object sender, CancelEventArgs e)
The source of the event.
eCancelEventArgsA CancelEventArgs that contains the event data.
Detaches from all events of its sub-elements.
protected virtual void UnwireEvents()
Updates all header texts.
protected virtual void UpdateHeadersText()
Attaches to all necessary events of its sub-elements.
protected virtual void WireEvents()
Events
Occurs when the control is clicked.
public event EventHandler Click
Occurs when a key is pressed down while the control has focus.
public event KeyEventHandler KeyDown
Occurs when a key is pressed while the control has focus.
public event KeyPressEventHandler KeyPress
Occurs when a key is released while the control has focus.
public event KeyEventHandler KeyUp
Occurs when the mouse pointer is over the control and a mouse button is released.
public event MouseEventHandler MouseUp
Occurs when the mouse wheel moves while the control has focus.
public event MouseEventHandler MouseWheel
Occurs when the content of a time cell needs to be formatted for display.
public event TimeCellFormattingEventHandler TimeCellFormatting
Occurs when the editing value has been changed
public event EventHandler ValueChanged
Occurs when the editing value is changing.
public event CancelEventHandler ValueChanging