Class

RadDateTimePickerElement

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

Declaration

public RadDateTimePickerElement()

Initializes a new instance of the RadDateTimePickerElement class with a specified behavior director.

Declaration

public RadDateTimePickerElement(RadDateTimePickerBehaviorDirector behaviorDirector)

Parameters

Represents the CalendarSize dependency property that defines the size of the dropdown calendar.

Declaration

public static RadProperty CalendarSizeProperty

Field Value

Represents the IsDropDownShown dependency property that indicates whether the dropdown calendar is currently visible.

Declaration

public static RadProperty IsDropDownShownProperty

Field Value

Gets the arrow button element that opens the dropdown calendar when clicked.

Declaration

public RadArrowButtonElement ArrowButton { get; }

Property Value

This property controls whether or not the next date part will be automatically selected when the user types.

Declaration

public bool AutoSelectNextPart { get; set; }

Property Value

Gets the nested RadCalendar control from the popup part of the RadDateTimePicker.

Declaration

public RadCalendar Calendar { get; }

Property Value

Gets or sets the location of the drop down showing the calendar

Declaration

[Browsable(false)]
public Point CalendarLocation { get; set; }

Property Value

Gets or sets the size of the calendar in the drop down

Declaration

[Browsable(true)]
public Size CalendarSize { get; set; }

Property Value

Gets or sets the checkbox element that allows toggling between null and valid date values.

Declaration

public RadCheckBoxElement CheckBox { get; }

Property Value

Gets or sets a value indicating whether the checkbox is checked when ShowCheckBox is true. When checked, indicates that the user has selected a valid date value.

Declaration

public bool Checked { get; set; }

Property Value

Gets or sets the CultureInfo supported by this RadCalendar object.

Describes the names of the culture, the writing system, and the calendar used, as well as access to culture-specific objects that provide methods for common operations, such as formatting dates and sorting strings.

Declaration

[TypeConverter(typeof(CultureInfoConverter))]
public CultureInfo Culture { get; set; }

Property Value

Remarks

Gets or sets the current behavior director that manages the interaction patterns for this element.

Declaration

public RadDateTimePickerBehaviorDirector CurrentBehavior { get; set; }

Property Value

Gets or sets the custom date/time format string.

Declaration

public string CustomFormat { get; set; }

Property Value

Gets the default null date value, which is MinValue.

Declaration

protected virtual DateTime DefaultNullDate { get; }

Property Value

Gets or sets the format of the date and time displayed in the control.

Declaration

public DateTimePickerFormat Format { get; set; }

Property Value

Gets or sets a value indicating whether the dropdown calendar is currently visible.

Declaration

public bool IsDropDownShown { get; }

Property Value

Gets or sets the maximum date and time that can be selected in the control.

Declaration

public DateTime MaxDate { get; set; }

Property Value

Gets or sets the absolute maximum date value allowed for any RadDateTimePickerElement control. This is a global setting that affects all instances.

Declaration

public static DateTime MaximumDateTime { get; set; }

Property Value

Gets or sets the minimum date and time that can be selected in the control.

Declaration

public DateTime MinDate { get; set; }

Property Value

Gets or sets the absolute minimum date value allowed for any RadDateTimePickerElement control. This is a global setting that affects all instances. Cannot be lower than the current culture's minimum supported date.

Declaration

public static DateTime MinimumDateTime { get; set; }

Property Value

Gets or sets the DateTime value assigned to the date picker when the Value is null. This value determines what date is considered as "no selection".

Declaration

[Bindable(false)]
public DateTime NullDate { get; set; }

Property Value

Gets or sets the text that is displayed when the DateTimePicker contains a null reference.

Declaration

public string NullText { get; set; }

Property Value

Gets or sets which part of the datetime structure will be included when checking for NullDate. This determines whether only the date part or both date and time parts are considered for null value comparisons.

Declaration

public virtual NullValueCheckMode NullValueCheckMode { get; set; }

Property Value

Gets or sets a value indicating whether RadDateTimePicker is read-only.

Declaration

public bool ReadOnly { get; set; }

Property Value

Indicates whether a check box is displayed in the control. When the check box is unchecked no value is selected

Declaration

public bool ShowCheckBox { get; set; }

Property Value

Gets or sets a value indicating whether the current time is displayed in the control.

Declaration

[Bindable(true)]
public bool ShowCurrentTime { get; set; }

Property Value

Gets or sets a value indicating whether the nested TimePicker element is shown in the popup part of the RadDateTimePicker.

Declaration

public bool ShowTimePicker { get; set; }

Property Value

Indicates whether a spin box rather than a drop down calendar is displayed for editing the control's value

Declaration

public bool ShowUpDown { get; set; }

Property Value

Gets an instance of RadMaskedEditBoxElement that handles text input and display for the date/time picker.

Declaration

[Browsable(false)]
public RadMaskedEditBoxElement TextBoxElement { get; }

Property Value

Gets or sets the nullable date/time value assigned to the control. Returns null when no valid date is selected or when the value equals NullDate.

Declaration

[Bindable(true)]
public DateTime? Value { get; set; }

Property Value

Raises the NullableValueChanged event. This method is intended for internal use.

Declaration

public void CallOnNullableValueChanged(EventArgs e)

Parameters

Raises the ValueChanged event. This method is intended for internal use.

Declaration

public void CallOnValueChanged(EventArgs e)

Parameters

Raises the ValueChanging event. This method is intended for internal use.

Declaration

public void CallOnValueChanging(ValueChangingEventArgs e)

Parameters

Creates and initializes child elements including the default behavior and sets initial values.

Declaration

protected override void CreateChildElements()

Overrides RadElement.CreateChildElements()

Creates a new instance of RadDateTimePickerBehaviorDirector that will manage the default behavior for this element.

Declaration

protected virtual RadDateTimePickerBehaviorDirector CreateDefaultBehavior()

Returns

Releases managed resources used by this element, including event handlers and behavior directors.

Declaration

protected override void DisposeManagedResources()

Overrides RadItem.DisposeManagedResources()

Gets the current behavior director of the control. By default it shows a calendar in the dropdown.

Declaration

public RadDateTimePickerBehaviorDirector GetCurrentBehavior()

Returns

Initializes internal fields and state values to their default settings.

Declaration

protected override void InitializeFields()

Overrides RadItem.InitializeFields()

Measures the element and calculates the desired size within the available space

Declaration

protected override SizeF MeasureOverride(SizeF availableSize)

Parameters

Returns

Overrides RadElement.MeasureOverride(SizeF)

Handles bit state changes for various boolean properties and notifies of property changes

Declaration

protected override void OnBitStateChanged(long key, bool oldValue, bool newValue)

Parameters

Overrides DisposableObject.OnBitStateChanged(long, bool, bool)

Raises the Closed event.

Declaration

protected virtual void OnClosed(RadPopupClosedEventArgs args)

Parameters

Raises the Closing event.

Declaration

protected virtual void OnClosing(RadPopupClosingEventArgs args)

Parameters

Raises the FormatChanged event when the date format has changed

Declaration

protected virtual void OnFormatChanged(EventArgs e)

Parameters

Handles key down events for navigation and dropdown functionality

Declaration

protected override void OnKeyDown(KeyEventArgs e)

Parameters

Overrides RadItem.OnKeyDown(KeyEventArgs)

Called when the element is loaded. Fixes a text display issue by refreshing the text box content.

Declaration

protected override void OnLoaded()

Overrides RadElement.OnLoaded()

Handles property change notifications and updates related components accordingly

Declaration

protected override void OnNotifyPropertyChanged(PropertyChangedEventArgs e)

Parameters

Overrides RadObject.OnNotifyPropertyChanged(PropertyChangedEventArgs)

Raises the NullableValueChanged event when the nullable value property changes

Declaration

protected virtual void OnNullableValueChanged(EventArgs e)

Parameters

Raises the Opened event.

Declaration

protected virtual void OnOpened(EventArgs args)

Parameters

Raises the Opening event.

Declaration

protected virtual void OnOpening(CancelEventArgs args)

Parameters

Handles property changes and updates element appearance based on the changed property

Declaration

protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)

Parameters

Overrides RadItem.OnPropertyChanged(RadPropertyChangedEventArgs)

Raises the ValueChanged event after the value has changed

Declaration

protected virtual void OnValueChanged(EventArgs e)

Parameters

Raises the ValueChanging event before a value change occurs, allowing cancellation

Declaration

protected virtual void OnValueChanging(ValueChangingEventArgs e)

Parameters

Resets the NullText property to its default value (empty string).

Declaration

public void ResetNullText()

Resets the current value to the current date/time and clears the user-set flag.

Declaration

public void ResetValue()

Sets the behavior of the date picker

Declaration

protected virtual void SetBehavior(RadDateTimePickerBehaviorDirector childrenDirector)

Parameters

Sets the current value to behave as a null value and clears any calendar selection.

Declaration

public void SetToNullValue()

Sets the value without triggering validation or range checking. This is primarily for internal use.

Declaration

public void SetValueOnly(DateTime? value)

Parameters

Determines whether the NullText property should be serialized.

Declaration

public bool ShouldSerializeNullText()

Returns

Gets the date value as a formatted string representation.

Declaration

public override string ToString()

Returns

Overrides RadComponentElement.ToString()

Closes the popup if it is open, or shows the popup if it is closed.

Declaration

protected virtual void ToogleDropDownState()

Unwires popup-related event handlers from the calendar behavior's popup control.

Declaration

protected virtual void UnwirePopupEvents(RadDateTimePickerCalendar calendarBehavior)

Parameters

Wires popup-related event handlers to the calendar behavior's popup control.

Declaration

protected virtual void WirePopupEvents(RadDateTimePickerCalendar calendarBehavior)

Parameters

Occurs when the value of the checkbox in the editor is changed

Declaration

public event EventHandler CheckedChanged

Event Value

Occurs when the drop down is closed

Declaration

public event RadPopupClosedEventHandler Closed

Event Value

Occurs when the drop down is closing

Declaration

public event RadPopupClosingEventHandler Closing

Event Value

Occurs when the Format property of the control has changed.

Declaration

public event EventHandler FormatChanged

Event Value

Occurs when MaskProvider has been created for the text box element. This event will be fired multiple times because the provider is recreated when properties like Mask, Culture, or MaskType change.

Declaration

public event EventHandler MaskProviderCreated

Event Value

Occurs when the nullable value of the control has changed.

Declaration

public event EventHandler NullableValueChanged

Event Value

Occurs when the drop down is opened

Declaration

public event EventHandler Opened

Event Value

Occurs when the drop down is opening

Declaration

public event CancelEventHandler Opening

Event Value

Occurs when the CheckBox's state changes.

Declaration

public event StateChangedEventHandler ToggleStateChanged

Event Value

Occurs before the CheckBox's state changes.

Declaration

public event StateChangingEventHandler ToggleStateChanging

Event Value

Occurs when the Value property of the control has changed.

Declaration

public event EventHandler ValueChanged

Event Value

Occurs when the Value property of the control is about to change and can be cancelled.

Declaration

public event ValueChangingEventHandler ValueChanging

Event Value