C1.WPF.DateTimeEditors.C1TimeEditor
C1TimeEditor Class
The C1TimeEditor control allows editing of TimeSpan values in different formats.
Namespace: C1.WPF.DateTimeEditors
Assembly: C1.WPF.DateTimeEditors.dll
Syntax
[StyleTypedProperty(Property = "IncreaseIconStyle", StyleTargetType = typeof(ContentControl))]
[StyleTypedProperty(Property = "DecreaseIconStyle", StyleTargetType = typeof(ContentControl))]
[StyleTypedProperty(Property = "IncreaseButtonStyle", StyleTargetType = typeof(C1RepeatButton))]
[StyleTypedProperty(Property = "DecreaseButtonStyle", StyleTargetType = typeof(C1RepeatButton))]
[StyleTypedProperty(Property = "ValidationDecoratorStyle", StyleTargetType = typeof(C1ValidationDecorator))]
[TemplatePart(Name = "TextBox", Type = typeof(C1MaskedTextBox))]
[TemplatePart(Name = "Increase", Type = typeof(C1RepeatButton))]
[TemplatePart(Name = "Decrease", Type = typeof(C1RepeatButton))]
[TemplatePart(Name = "ValidationDecorator", Type = typeof(C1ValidationDecorator))]
[TemplateVisualState(Name = "Normal", GroupName = "CommonStates")]
[TemplateVisualState(Name = "MouseOver", GroupName = "CommonStates")]
[TemplateVisualState(Name = "Focused", GroupName = "CommonStates")]
[TemplateVisualState(Name = "Disabled", GroupName = "CommonStates")]
[TemplateVisualState(Name = "ShowButtons", GroupName = "ButtonsVisibilityStates")]
[TemplateVisualState(Name = "HideButtons", GroupName = "ButtonsVisibilityStates")]
public class C1TimeEditor : C1ViewConstructors
| Name | Description |
|---|---|
| C1TimeEditor() | Initializes a new instance of the C1TimeEditor class. |
Fields
| Name | Description |
|---|---|
| AllowNullProperty | Identifies the AllowNull dependency property. |
| CaretBrushProperty | Identifies the CaretBrush dependency property. |
| CustomFormatProperty | Identifies the CustomFormat dependency property. |
| CycleChangesOnBoundariesProperty | Identifies the CycleChangesOnBoundaries dependency property. |
| DecreaseButtonStyleProperty | Identifies the DecreaseButtonStyle dependency property. |
| DecreaseIconStyleProperty | Identifies the DecreaseIconStyle dependency property. |
| DecreaseIconTemplateProperty | Identifies the DecreaseIconTemplate dependency property. |
| DelayProperty | Identifies the Delay dependency property. |
| FocusBrushProperty | Identifies the FocusBrush dependency property. |
| FocusCuesVisibilityProperty | Identifies the FocusCuesVisibility dependency property. |
| FormatProperty | Identifies the Format dependency property. |
| HandleUpDownKeysProperty | Identifies the HandleUpDownKeys dependency property. |
| IncreaseButtonStyleProperty | Identifies the IncreaseButtonStyle dependency property. |
| IncreaseIconStyleProperty | Identifies the IncreaseIconStyle dependency property. |
| IncreaseIconTemplateProperty | Identifies the IncreaseIconTemplate dependency property. |
| IncrementProperty | Identifies the Increment dependency property. |
| IntervalProperty | Identifies the Interval dependency property. |
| IsReadOnlyProperty | Identifies the IsReadOnly dependency property. |
| MaskProperty | Identifies the Mask dependency property. |
| MaximumProperty | Identifies the Maximum dependency property. |
| MinimumProperty | Identifies the Minimum dependency property. |
| MouseOverBorderBrushProperty | Identifies the MouseOverBorderBrush dependency property. |
| MouseOverBrushProperty | Identifies the MouseOverBrush dependency property. |
| PlaceholderProperty | Identifies the Placeholder dependency property. |
| PressedBrushProperty | Identifies the PressedBrush dependency property. |
| PromptProperty | Identifies the Prompt dependency property. |
| ShowButtonsProperty | Identifies the ShowButtons dependency property. |
| ValidationDecoratorStyleProperty | Identifies the ValidationDecoratorStyle dependency property. |
| ValueProperty | Identifies the Value dependency property. |
Properties
| Name | Description |
|---|---|
| AllowNull | Gets or sets whether the user can enter null values. |
| CaretBrush | Gets or sets the Brush of the blinking cursor of an input control. |
| CustomFormat | Gets or sets the custom date/time format string. |
| CycleChangesOnBoundaries | Determines the C1TimeEditor behavior at changing its value by up/down buttons or arrow keys when Value property is equal to Minimum or Maximum property value. The default is true. |
| DecreaseButtonStyle | Gets or sets the style of the button that decreases the value. |
| DecreaseIconStyle | Gets or sets the style of the icon shown in the decrease button. |
| DecreaseIconTemplate | Gets or sets the template of the icon used in the decrease button. |
| Delay | Gets or sets the delay for the Increase and Decrease buttons. |
| FocusBrush | Gets or sets the Brush used to highlight the focused control. |
| FocusCuesVisibility | Gets or sets a value indicating whether the focus visuals of the control are visible. |
| Format | Gets or sets the TimeSpan format the C1TimeEditor control displays. |
| HandleUpDownKeys | Gets or sets if the control handles the Up / Down / PageUp / PageDown keys. |
| IncreaseButtonStyle | Gets or sets the style of the button that increases the value. |
| IncreaseIconStyle | Gets or sets the style of the icon shown in the increase button. |
| IncreaseIconTemplate | Gets or sets the template of the icon used in the increase button. |
| Increment | Gets or sets the increment applied when the user pressed the up/down arrow keys. |
| Interval | Gets or sets the time, in milliseconds, between repetitions of the click action, as soon as repeating starts, applied to the Increase and Decrease buttons. |
| IsFocused | Gets whether the control is focused. |
| IsReadOnly | Gets or sets the value that determines if the C1TimeEditor is read-only. |
| Mask | Gets or sets the input mask. |
| Maximum | Gets or sets the maximum value allowed for the C1TimeEditor. |
| Minimum | Gets or sets the minimum value allowed for the C1TimeEditor. |
| MouseOverBorderBrush | Gets or sets the Brush used to highlight the border of the control when it has the mouse over. |
| MouseOverBrush | Gets or sets the Brush used to highlight the control when it has the mouse over. |
| Placeholder | Gets or sets the placeholder text. |
| PressedBrush | Gets or sets the Brush used to paint a button when it is pressed. |
| Prompt | Gets or sets the character used to show spaces where user is supposed to type. |
| ShowButtons | Shows or hides the buttons for Increment or Decrement. |
| ValidationDecoratorStyle | Gets or sets the style that is applied to the inner C1.WPF.Input.C1ValidationDecorator. |
| Value | Gets or sets the TimeSpan value in the C1TimeEditor control. |
Methods
| Name | Description |
|---|---|
| ChangeVisualStateButtonsVisibility(bool) | Updates the current visual state of the ButtonsVisibility visual state group to match the object's properties. |
| ChangeVisualStateCommon(bool) | Updates the current visual state of the Common visual state group to match the object's properties. |
| Dispose(bool) | |
| FinalizeEditing() | Forces the Value property update. |
| GetCurrentDateTimeFormat() | Gets the current date time format. |
| GetCurrentDateTimeFormat(FrameworkElement) | Gets the current date time format based on the specified element Language property value. |
| GetGregorianCulture(CultureInfo) | If specified Culture's calendar is not Gregorian, searches for localized Gregorian calendar in optional calendars and returns new culture with Gregorian calendar. |
| OnApplyTemplate() | |
| OnIsKeyboardFocusWithinChanged(DependencyPropertyChangedEventArgs) | |
| OnMouseWheel(MouseWheelEventArgs) | |
| OnTextValidationError(TextValidationErrorEventArgs) | Raises the TextValidationError event. |
| OnValueChanged(NullablePropertyChangedEventArgs<TimeSpan>) | Raises the ValueChanged event. |
| ToString() | Provides a text representation of the selected date. |
Events
| Name | Description |
|---|---|
| TextValidationError | Occurs when text entered into the C1TimeEditor cannot be parsed or the TimeSpan is not valid to be selected. |
| ValueChanged | Fires when the Value property changes. |