Class

MaskTimeSpanProvider

Initializes a new instance of the MaskTimeSpanProvider class.

Declaration

public MaskTimeSpanProvider(string mask, CultureInfo culture, RadMaskedEditBoxElement owner)

Parameters

Declaration

protected int keyCounter

Field Value

Declaration

protected int oldSelectedIndex

Field Value

Gets or sets a value indicating whether to automatically select the next part during the editing.

Declaration

public bool AutoSelectNextPart { get; set; }

Property Value

Gets the culture that determines the value of the localizable separators and placeholders in the input mask.

Declaration

public CultureInfo Culture { get; }

Property Value

Implements IMaskProvider.Culture

Gets or sets the days step used when modifying the value.

Declaration

public int DaysStep { get; set; }

Property Value

Enable or Disable the selection of the next or previous part of the date with arrow keys

Declaration

public bool EnableKeyNavigation { get; set; }

Property Value

Gets or sets the hours step used when modifying the value.

Declaration

public int HoursStep { get; set; }

Property Value

Gets the input mask.

Declaration

public string Mask { get; }

Property Value

Implements IMaskProvider.Mask

Gets or sets the mask based on the format string.

Declaration

public string MaskFromFormat { get; set; }

Property Value

A list with TimeSpanMaskPart objects used to validate the value and user input.

Declaration

public List<TimeSpanMaskPart> MaskParts { get; set; }

Property Value

Gets or sets the maximum value.

Declaration

public TimeSpan Maximum { get; set; }

Property Value

Gets or sets the milliseconds step used when modifying the value.

Declaration

public int MillisecondsStep { get; set; }

Property Value

Gets or sets the minimum value.

Declaration

public TimeSpan Minimum { get; set; }

Property Value

Gets or sets the minutes step used when modifying the value.

Declaration

public int MinutesStep { get; set; }

Property Value

Gets the owner RadMaskedEditBoxElement.

Declaration

public RadMaskedEditBoxElement Owner { get; }

Property Value

Gets or sets the seconds step used when modifying the value.

Declaration

public int SecondsStep { get; set; }

Property Value

Gets or sets the index of the selected item of the MaskParts.

Declaration

public int SelectedItemIndex { get; set; }

Property Value

Gets the text box item.

Declaration

public RadTextBoxItem TextBoxItem { get; }

Property Value

Implements IMaskProvider.TextBoxItem

Gets or sets the value.

Declaration

public virtual object Value { get; set; }

Property Value

Implements IMaskProvider.Value

Adjusts the offset of the items in the list.

Declaration

protected static void AdjustItemsOffset(IList<TimeSpanMaskPart> collection, TimeSpan value)

Parameters

Sets the min and max values to each TimeSpanMaskPart in the MaskParts.

Declaration

protected virtual void AdjustMaskPartsMinMaxValues()

Invokes the ValueChanged event of the owner.

Declaration

protected virtual void CallOwnerValueChanged()

Invokes the ValueChanging event of the owner.

Declaration

protected virtual void CallOwnerValueChanging(ValueChangingEventArgs args)

Parameters

Occurs when the user clicks with the mouse.

Declaration

public virtual bool Click()

Returns

Implements IMaskProvider.Click()

Clones this instance.

Declaration

public IMaskProvider Clone()

Returns

Implements IMaskProvider.Clone()

Raises the delete operation for currently selected mask part.

Declaration

public bool Delete()

Returns

Implements IMaskProvider.Delete()

Decreases the value of the given TimeSpanMaskPart.

Declaration

public virtual void Down(TimeSpanMaskPart part, TimeSpan minTimeSpan, TimeSpan maxTimeSpan)

Parameters

Returns a list used to validate the value and user input.

Declaration

public static List<TimeSpanMaskPart> FillCollection(string mask)

Parameters

Returns

Fills the MaskParts with TimeSpanMaskPart objects used to validate the value and user input.

Declaration

protected virtual List<TimeSpanMaskPart> FillCollectionInternal(string mask)

Parameters

Returns

Fills the collection with values based on the given value.

Declaration

protected virtual void FillMaskPartCollectionValuesInternal(IList<TimeSpanMaskPart> collection, TimeSpan timeSpan)

Parameters

Fills the collection with values based on the given value.

Declaration

public static void FillMaskPartsCollectionValues(IList<TimeSpanMaskPart> collection, TimeSpan timeSpan)

Parameters

Gets the group length of the mask.

Declaration

protected static int GetGroupLengthByMask(string mask)

Parameters

Returns

Gets the format string from the mask using the culture specific format info.

Declaration

public static string GetSpecificFormat(string mask)

Parameters

Returns

Gets the format string from the mask using the culture specific format info.

Declaration

protected virtual string GetSpecificFormatInternal(string mask)

Parameters

Returns

Handles a key press operation over a specific TimeSpanMaskPart.

Declaration

protected virtual bool HandleKeyPress(TimeSpanMaskPart part, KeyPressEventArgs e)

Parameters

Returns

Handles a key press operation over a day TimeSpanMaskPart.

Declaration

protected virtual void HandleKeyPressDay(TimeSpanMaskPart part, KeyPressEventArgs e)

Parameters

Handles a key press operation over an hour TimeSpanMaskPart.

Declaration

protected virtual void HandleKeyPressHour(TimeSpanMaskPart part, KeyPressEventArgs e)

Parameters

Handles a key press operation with a character. Tries to match the value by the given names collection.

Declaration

protected virtual void HandleKeyPressWithCharacters(TimeSpanMaskPart part, KeyPressEventArgs e, string[] names)

Parameters

Handles a spin down operation, usually when the keyboard down arrow key was pressed.

Declaration

public virtual void HandleSpinDown(TimeSpan minTimeSpan, TimeSpan maxTimeSpan)

Parameters

Handles a spin up operation, usually when the keyboard up arrow key was pressed.

Declaration

public virtual void HandleSpinUp(TimeSpan minTimeSpan, TimeSpan maxTimeSpan)

Parameters

Occurs when a key is pressed.

Declaration

public virtual void KeyDown(object sender, KeyEventArgs e)

Parameters

Implements IMaskProvider.KeyDown(object, KeyEventArgs)

Occurs when a key is pressed.

Declaration

public virtual void KeyPress(object sender, KeyPressEventArgs e)

Parameters

Implements IMaskProvider.KeyPress(object, KeyPressEventArgs)

Resets the value of the currently selected part of the mask.

Declaration

public virtual void ResetCurrentPartValue(object sender, KeyEventArgs e)

Parameters

Resets the given part value if the key char is delete or backspace.

Declaration

protected virtual bool ResetOnDelPartValue(TimeSpanMaskPart part, int keyChar)

Parameters

Returns

Resets the value to the Minimum.

Declaration

public virtual void ResetToMinTimeSpan()

Restores the selected item from the MaskParts, usually after a value change operation.

Declaration

protected virtual void RestoreSelectedItem()

Selects the current TimeSpanMaskPart based on the caret position.

Declaration

public virtual bool SelectCurrentItemFromCurrentCaret()

Returns

Selects the text in the TextBoxItem which corresponds to the SelectedItemIndex in the MaskParts.

Declaration

public virtual void SelectCurrentItemWithSelectedItem()

Selects the first editable TimeSpanMaskPart in the MaskParts list.

Declaration

public virtual void SelectFirstEditableItem()

Selects the first TimeSpanMaskPart in the MaskParts list.

Declaration

public virtual void SelectFirstItem()

Selects the last editable TimeSpanMaskPart in the MaskParts list.

Declaration

public virtual void SelectLastEditableItem()

Selects the last TimeSpanMaskPart in the MaskParts list.

Declaration

public virtual void SelectLastItem()

Selects the previous editable TimeSpanMaskPart in the MaskParts.

Declaration

public virtual void SelectNextEditableItem()

Selects the next editable TimeSpanMaskPart based on the caret position.

Declaration

public virtual bool SelectNextEditableItemFromCurrentCaret()

Returns

Selects the next TimeSpanMaskPart based on the SelectedItemIndex.

Declaration

public virtual void SelectNextItem()

Selects the next TimeSpanMaskPart based on the caret position.

Declaration

public virtual void SelectNextItemFromCurrentCaret()

Selects the previous editable TimeSpanMaskPart in the MaskParts list.

Declaration

public virtual void SelectPrevEditableItem()

Selects the previous TimeSpanMaskPart based on the SelectedItemIndex.

Declaration

public virtual void SelectPrevItem()

Selects the previous TimeSpanMaskPart based on the caret position.

Declaration

public virtual void SelectPrevItemFromCurrentCaret()

Returns a formatted TimeSpan string.

Declaration

public override string ToString()

Returns

Overrides object.ToString()

Returns a formatted TimeSpan string based on the list of TimeSpanMaskPart.

Declaration

public static string ToString(TimeSpan value, IList<TimeSpanMaskPart> maskParts, CultureInfo culture)

Parameters

Returns

Returns a formatted TimeSpan string based on the given format string.

Declaration

public static string ToString(TimeSpan value, string format, CultureInfo culture)

Parameters

Returns

Gets the string interpretation of the value based on the Mask

Declaration

public string ToString(bool includePrompt, bool includeLiterals)

Parameters

Returns

Implements IMaskProvider.ToString(bool, bool)

Returns a formatted TimeSpan string based on the given format string.

Declaration

protected virtual string ToStringInternal(TimeSpan value, string format)

Parameters

Returns

Increases the value of the given TimeSpanMaskPart.

Declaration

public virtual void Up(TimeSpanMaskPart part, TimeSpan minTimeSpan, TimeSpan maxTimeSpan)

Parameters

Validates the given string value and sets it as Value if the value is valid. If the value cannot be parsed to the underlying data type of the Value, it is reset to its default value.

Declaration

public virtual bool Validate(string stringValue)

Parameters

Returns

Implements IMaskProvider.Validate(string)

Occurs when the selected item is changed.

Declaration

public event EventHandler SelectedItemChanged

Event Value