DateTimeEditBox Class
Represents a date/time edit box.
public class DateTimeEditBox : PartEditBoxBase<DateTime?>
- Inheritance:
- object Visual UIElement FrameworkElement Control PartEditBoxBase<DateTime?> object
- Derived:
- DateEditBox TimeEditBox
Constructors
DateTimeEditBox()
Initializes an instance of the DateTimeEditBox
class.
public DateTimeEditBox()
Properties
Format
Gets or sets the date/time format string.
public string Format { get; set; }
Property Value
- string:
The date/time format string. The default value is
"g"
.
HasPopupButtonWhenReadOnly
Gets whether the control should display the popup button when the control is read-only.
protected override bool HasPopupButtonWhenReadOnly { get; }
Property Value
- bool:
true
if the control should display the popup button when the control is read-only; otherwise,false
.
Maximum
Gets or sets the highest possible value.
Minimum
Gets or sets the lowest possible value.
ResolvedFormat
Gets the resolved date/time format string.
SetValueToNowCommand
Gets the ICommand that sets the value to the current date/time.
public ICommand SetValueToNowCommand { get; }
Property Value
SetValueToTodayCommand
Gets the ICommand that sets the value to the current date.
public ICommand SetValueToTodayCommand { get; }
Property Value
Methods
CoerceParsedValue(DateTime?)
Coerces the parsed value from text, only using components from the value for which parts are displayed in the edit box.
protected virtual DateTime? CoerceParsedValue(DateTime? value)
Parameter | Type | Description |
---|---|---|
value | DateTime? | The value to coerce. |
Returns
- DateTime?:
The coerced value.
Remarks
The logic in this method ensures that time-only edit boxes retain their dates, month/day date-only edit boxes retain their years, etc.
CoerceValidValue(DateTime?)
Coerces the value to be within range.
protected override DateTime? CoerceValidValue(DateTime? value)
Parameter | Type | Description |
---|---|---|
value | DateTime? | The value to coerce. |
Returns
- DateTime?:
The coerced value.
ConvertToString(DateTime?)
Converts the specified value to a string representation.
protected override string ConvertToString(DateTime? valueToConvert)
Parameter | Type | Description |
---|---|---|
valueToConvert | DateTime? | The value. |
Returns
- string:
The string representation of the specified value.
CreateIncrementalChangeRequest(IncrementalChangeRequestKind)
Creates an incremental change (spin) request.
protected override IncrementalChangeRequest<DateTime?> CreateIncrementalChangeRequest(IncrementalChangeRequestKind kind)
Parameter | Type | Description |
---|---|---|
kind | IncrementalChangeRequestKind | The kind of request. |
Returns
- IncrementalChangeRequest<DateTime?>:
The incremental change (spin) request that was created.
GenerateParts()
Generates the parts for the edit box.
protected override IList<IPart> GenerateParts()
Returns
IsValidValue(DateTime?)
Returns whether the specified value is valid.
protected override bool IsValidValue(DateTime? value)
Parameter | Type | Description |
---|---|---|
value | DateTime? | The value to examine. |
Returns
- bool:
true
if the value is valid; otherwise,false
.
OnPopupOpened()
Occurs when the popup is opened.
protected override void OnPopupOpened()
RaiseValueChangedEvent()
Raises the ValueChanged event.
protected override void RaiseValueChangedEvent()
ResetValue()
Resets the value to a default value.
protected override void ResetValue()
TryConvertFromString(string, bool, out DateTime?)
Tries to convert the specified text to a value.
protected override bool TryConvertFromString(string textToConvert, bool canCoerce, out DateTime? value)
Parameter | Type | Description |
---|---|---|
textToConvert | string | The text. |
canCoerce | bool | Whether the returned value should be coerced to fall within the allowed value range. |
value | DateTime? | Returns the value for the specified text. |
Returns
- bool:
true
if the text was converted to a value successfully; otherwise,false
.
Events
ValueChanged
Occurs after the Value
property value changes.
Fields
FormatProperty
Identifies the Format dependency property. This field is read-only.
public static readonly DependencyProperty FormatProperty
MaximumProperty
Identifies the Maximum dependency property. This field is read-only.
public static readonly DependencyProperty MaximumProperty
MinimumProperty
Identifies the Minimum dependency property. This field is read-only.
public static readonly DependencyProperty MinimumProperty
ResolvedFormatProperty
Identifies the ResolvedFormat dependency property. This field is read-only.
public static readonly DependencyProperty ResolvedFormatProperty
Inherited Members
- PartEditBoxBase<DateTime?>.ActivePartIndexProperty
- PartEditBoxBase<DateTime?>.CommitTriggersProperty
- PartEditBoxBase<DateTime?>.HasPopupProperty
- PartEditBoxBase<DateTime?>.InlinesProperty
- PartEditBoxBase<DateTime?>.InputScopeNameValueProperty
- PartEditBoxBase<DateTime?>.IntermediateValueProperty
- PartEditBoxBase<DateTime?>.IsArrowKeyPartNavigationEnabledProperty
- PartEditBoxBase<DateTime?>.IsEditableProperty
- PartEditBoxBase<DateTime?>.IsNullAllowedProperty
- PartEditBoxBase<DateTime?>.IsPopupButtonVisibleProperty
- PartEditBoxBase<DateTime?>.IsPopupOpenProperty
- PartEditBoxBase<DateTime?>.IsReadOnlyProperty
- PartEditBoxBase<DateTime?>.IsSpinnerVisibleProperty
- PartEditBoxBase<DateTime?>.IsUndoEnabledProperty
- PartEditBoxBase<DateTime?>.PlaceholderTextProperty
- PartEditBoxBase<DateTime?>.PopupBackgroundProperty
- PartEditBoxBase<DateTime?>.PopupBorderBrushProperty
- PartEditBoxBase<DateTime?>.PopupPickerStyleProperty
- PartEditBoxBase<DateTime?>.SpinWrappingProperty
- PartEditBoxBase<DateTime?>.TextAlignmentProperty
- PartEditBoxBase<DateTime?>.ValueProperty
- PartEditBoxBase<DateTime?>.IsNonDefaultUsageContextProperty
- PartEditBoxBase<DateTime?>.SpinnerVisibilityProperty
- PartEditBoxBase<DateTime?>.UsageContextProperty
- PartEditBoxBase<DateTime?>.Commit()
- PartEditBoxBase<DateTime?>.Commit(bool)
- PartEditBoxBase<DateTime?>.InvalidateParts()
- PartEditBoxBase<DateTime?>.OnApplyTemplate()
- PartEditBoxBase<DateTime?>.OnCreateAutomationPeer()
- PartEditBoxBase<DateTime?>.OnGotFocus(RoutedEventArgs)
- PartEditBoxBase<DateTime?>.OnIntermediateValueChanged(DateTime?, DateTime?)
- PartEditBoxBase<DateTime?>.OnIsNullAllowedChanged(bool, bool)
- PartEditBoxBase<DateTime?>.OnKeyDown(KeyEventArgs)
- PartEditBoxBase<DateTime?>.OnLostFocus(RoutedEventArgs)
- PartEditBoxBase<DateTime?>.OnValueChanged(DateTime?, DateTime?)
- PartEditBoxBase<DateTime?>.ProcessTextInput(string)
- PartEditBoxBase<DateTime?>.SelectAll()
- PartEditBoxBase<DateTime?>.UpdateIntermediateValueAndTextFromValue()
- PartEditBoxBase<DateTime?>.OnIsKeyboardFocusWithinChanged(DependencyPropertyChangedEventArgs)
- PartEditBoxBase<DateTime?>.OnLostMouseCapture(MouseEventArgs)
- PartEditBoxBase<DateTime?>.OnMouseLeftButtonDown(MouseButtonEventArgs)
- PartEditBoxBase<DateTime?>.OnPreviewMouseUp(MouseButtonEventArgs)
- PartEditBoxBase<DateTime?>.OnPreviewTextInput(TextCompositionEventArgs)
- PartEditBoxBase<DateTime?>.ActivePartIndex
- PartEditBoxBase<DateTime?>.CommitTriggers
- PartEditBoxBase<DateTime?>.CurrentSelectionLength
- PartEditBoxBase<DateTime?>.CurrentSelectionStartOffset
- PartEditBoxBase<DateTime?>.CurrentText
- PartEditBoxBase<DateTime?>.HasPopup
- PartEditBoxBase<DateTime?>.Inlines
- PartEditBoxBase<DateTime?>.InputScopeNameValue
- PartEditBoxBase<DateTime?>.IntermediateValue
- PartEditBoxBase<DateTime?>.IsArrowKeyPartNavigationEnabled
- PartEditBoxBase<DateTime?>.IsEditable
- PartEditBoxBase<DateTime?>.IsNullAllowed
- PartEditBoxBase<DateTime?>.IsPopupButtonVisible
- PartEditBoxBase<DateTime?>.IsPopupOpen
- PartEditBoxBase<DateTime?>.IsReadOnly
- PartEditBoxBase<DateTime?>.IsSpinnerVisible
- PartEditBoxBase<DateTime?>.IsUndoEnabled
- PartEditBoxBase<DateTime?>.Parts
- PartEditBoxBase<DateTime?>.PlaceholderText
- PartEditBoxBase<DateTime?>.PopupBackground
- PartEditBoxBase<DateTime?>.PopupBorderBrush
- PartEditBoxBase<DateTime?>.PopupPickerStyle
- PartEditBoxBase<DateTime?>.ResetValueCommand
- PartEditBoxBase<DateTime?>.SmallDecrementValueCommand
- PartEditBoxBase<DateTime?>.SmallIncrementValueCommand
- PartEditBoxBase<DateTime?>.SpinWrapping
- PartEditBoxBase<DateTime?>.TextAlignment
- PartEditBoxBase<DateTime?>.Value
- PartEditBoxBase<DateTime?>.IsNonDefaultUsageContext
- PartEditBoxBase<DateTime?>.SpinnerVisibility
- PartEditBoxBase<DateTime?>.UsageContext