[]
        
(Showing Draft Content)

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.4.6.2.dll
Syntax
[TemplateVisualState(Name = "MouseOver", GroupName = "CommonStates")]
[TemplateVisualState(Name = "Disabled", GroupName = "CommonStates")]
[TemplateVisualState(Name = "Normal", GroupName = "CommonStates")]
[TemplatePart(Name = "TextBox", Type = typeof(C1TextBoxBase))]
[TemplatePart(Name = "Increase", Type = typeof(RepeatButton))]
[TemplatePart(Name = "Decrease", Type = typeof(RepeatButton))]
[TemplateVisualState(Name = "ShowButtons", GroupName = "ButtonsVisibilityStates")]
[TemplateVisualState(Name = "HideButtons", GroupName = "ButtonsVisibilityStates")]
[TemplateVisualState(Name = "Focused", GroupName = "FocusStates")]
[TemplateVisualState(Name = "Unfocused", GroupName = "FocusStates")]
[TemplateVisualState(Name = "Valid", GroupName = "ValidationStatesStates")]
[TemplateVisualState(Name = "InvalidUnfocused", GroupName = "ValidationStatesStates")]
[TemplateVisualState(Name = "InvalidFocused", GroupName = "ValidationStatesStates")]
[StyleTypedProperty(Property = "ValidationDecoratorStyle", StyleTargetType = typeof(C1ValidationDecorator))]
public class C1TimeEditor : Control, IAnimatable, IFrameworkInputElement, IInputElement, ISupportInitialize, IQueryAmbient

Constructors

Name Description
C1TimeEditor()

Initializes a new instance of a C1TimeEditor.

Fields

Name Description
AllowNullProperty

Identifies the AllowNull dependency property.

ButtonBackgroundProperty

Identifies the ButtonBackground dependency property.

ButtonForegroundProperty

Identifies the ButtonForeground dependency property.

CaretBrushProperty

Identifies the CaretBrush dependency property.

CornerRadiusProperty

Identifies the CornerRadius dependency property.

CustomFormatProperty

Identifies the CustomFormat dependency property.

CycleChangesOnBoundariesProperty

Identifies the CycleChangesOnBoundaries dependency property.

DelayProperty

Identifies the Delay dependency property.

DisabledCuesVisibilityProperty

Identifies the DisabledCuesVisibility 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.

IncrementProperty

Identifies the Increment dependency property.

IntervalProperty

Identifies the Interval dependency property.

IsFocusedProperty

Identifies the IsFocused 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.

MouseOverBrushProperty

Identifies the MouseOverBrush dependency property.

PressedBrushProperty

Identifies the PressedBrush dependency property.

PromptProperty

Identifies the Prompt dependency property.

SelectionBackgroundProperty

Identifies the C1.WPF.DateTimeEditors.C1TimeEditor.SelectionBackground dependency property.

SelectionForegroundProperty

Identifies the C1.WPF.DateTimeEditors.C1TimeEditor.SelectionForeground dependency property.

ShowButtonsProperty

Identifies the ShowButtons dependency property.

ValidationDecoratorStyleProperty

Identifies the ValidationDecoratorStyle dependency property.

ValueProperty

Identifies the Value dependency property.

WatermarkProperty

Identifies the Watermark dependency property.

Properties

Name Description
AllowNull

Gets or sets whether the user can enter null values.

ButtonBackground

Gets or sets the Brush that will be assigned to the Background of the buttons inside the control.

ButtonForeground

Gets or sets the Brush that will be assigned to the Foreground of the buttons inside the control.

CaretBrush

Gets or sets the Brush of the blinking cursor of an input control. When .NET Framework is v3.5, 'CaretBrush' takes no effect.

CornerRadius

Gets or sets a value that represents the degree to which the corners of the element are rounded.

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.

Delay

Gets or sets the delay for the Increase and Decrease buttons.

DisabledCuesVisibility

Gets or sets a value indicating whether the disabled visuals of the control are visible.

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

Specifies the TimeSpan format the C1TimeEditor control displays.

HandleUpDownKeys

Gets or sets If the control handles the Up / Down / PageUp / PageDown keys.

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

Returns true if the control has the focus.

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.

MouseOverBrush

Gets or sets the Brush used to highlight the control when it has the mouse over.

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.C1ValidationDecorator.

Value

Gets or sets the TimeSpan value in the C1TimeEditor control.

Watermark

Gets or sets the content of the watermark.

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.

ChangeVisualStateFocus(bool)

Updates the current visual state of the Focus visual state group to match the object's properties.

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()

Builds the visual tree for the C1TimeEditor control when a new template is applied.

OnCreateAutomationPeer()

Gets an AutomationPeer object used for testing the control.

OnMouseWheel(MouseWheelEventArgs)
OnPropertyChanged(DependencyPropertyChangedEventArgs)

Invoked whenever the effective value of any dependency property has been updated.

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
IsMouseOverChanged

Event raised when the IsMouseOver property has changed.

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.