New to Telerik UI for WinForms? Start a free 30-day trial

BaseMaskDateProvider

Class

A base provider used in all date and time related structures(DateTime, DateOnly, TimeOnly, TimeSpan)

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.UI.dll

Syntax:

public abstract class BaseMaskDateProvider : IMaskProvider

Inheritance: objectBaseMaskDateProvider

Derived Classes: MaskDateTimeProvider

Implements: IMaskProvider

Constructors

BaseMaskDateProvider(string, CultureInfo, RadMaskedEditBoxElement)

Initializes a new instance of the BaseMaskDateProvider class.

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

Parameters:maskstring

The mask.

cultureCultureInfo

The culture.

ownerRadMaskedEditBoxElement

The owner.

Fields

keyCounter

int

protected int keyCounter

oldSelectedIndex

int

protected int oldSelectedIndex

Properties

AutoSelectNextPart

bool

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

public bool AutoSelectNextPart { get; set; }

Culture

CultureInfo

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

public CultureInfo Culture { get; }

Property Value:

A System.Globalization.CultureInfo containing the culture information associated with the input mask.

Implements: IMaskProvider.Culture

DateTimeFormatInfo

Gets or sets the DateTimeFormatInfo used to provide culture specific date and time parts.

public DateTimeFormatInfo DateTimeFormatInfo { get; set; }

EnableKeyNavigation

bool

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

public bool EnableKeyNavigation { get; set; }

List

List<MaskPart>

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

public List<MaskPart> List { get; set; }

Mask

string

Gets the input mask.

public string Mask { get; protected set; }

Property Value:

A string containing the full mask.

Implements: IMaskProvider.Mask

MaskFromFormat

string

Gets or sets the mask based on the format string.

public string MaskFromFormat { get; set; }

Owner

RadMaskedEditBoxElement

Gets the owner RadMaskedEditBoxElement.

public RadMaskedEditBoxElement Owner { get; }

SelectedItemIndex

int

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

public int SelectedItemIndex { get; set; }

TextBoxItem

RadTextBoxItem

Gets the text box item.

public RadTextBoxItem TextBoxItem { get; }

Implements: IMaskProvider.TextBoxItem

Value

object

Gets or sets the value.

public abstract object Value { get; set; }

Implements: IMaskProvider.Value

Methods

AdjustItemsOffset()

Adjusts the offset of the items in the list.

protected virtual void AdjustItemsOffset()

Click()

Occurs when the user clicks with the mouse.

public virtual bool Click()

Returns:

bool

Not used

Implements: IMaskProvider.Click()

Clone()

Clones this instance.

public abstract IMaskProvider Clone()

Returns:

IMaskProvider

The cloned instance.

Implements: IMaskProvider.Clone()

Delete()

Raises the delete operation for currently selected mask part.

public bool Delete()

Returns:

bool

Not used.

Implements: IMaskProvider.Delete()

FillCollection()

Fills the List with MaskPart objects used to validate the value and user input.

protected abstract void FillCollection()

FillCollectionWithValues()

Fills the List with values based on the Value.

protected abstract void FillCollectionWithValues()

GetGroupLengthByMask(string)

Gets the group length of the mask.

protected static int GetGroupLengthByMask(string mask)

Parameters:maskstringReturns:

int

The group length of the mask.

KeyDown(object, KeyEventArgs)

Occurs when a key is pressed.

public abstract void KeyDown(object sender, KeyEventArgs e)

Parameters:senderobject

The sender.

eKeyEventArgs

Key event arguments.

Implements: IMaskProvider.KeyDown(object, KeyEventArgs)

KeyPress(object, KeyPressEventArgs)

Occurs when a key is pressed.

public abstract void KeyPress(object sender, KeyPressEventArgs e)

Parameters:senderobject

The sender.

eKeyPressEventArgs

Key event arguments.

Implements: IMaskProvider.KeyPress(object, KeyPressEventArgs)

ResetCurrentPartValue(object, KeyEventArgs)

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

public abstract void ResetCurrentPartValue(object sender, KeyEventArgs e)

Parameters:senderobject

The sender.

eKeyEventArgs

Key event arguments.

RestoreSelectedItem()

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

protected virtual void RestoreSelectedItem()

SelectCurrentItemFromCurrentCaret()

Selects the current MaskPart based on the caret position.

public abstract bool SelectCurrentItemFromCurrentCaret()

Returns:

bool

A value indicating whether a part was selected.

SelectCurrentItemWithSelectedItem()

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

public abstract void SelectCurrentItemWithSelectedItem()

SelectFirstEditableItem()

Selects the first editable MaskPart in the List.

public virtual void SelectFirstEditableItem()

SelectFirstItem()

Selects the first MaskPart in the List.

public virtual void SelectFirstItem()

SelectLastEditableItem()

Selects the last editable MaskPart in the List.

public virtual void SelectLastEditableItem()

SelectLastItem()

Selects the last MaskPart in the List.

public virtual void SelectLastItem()

SelectNextEditableItem()

Selects the previous editable MaskPart in the List.

public virtual void SelectNextEditableItem()

SelectNextEditableItemFromCurrentCaret()

Selects the next editable MaskPart based on the caret position.

public virtual bool SelectNextEditableItemFromCurrentCaret()

Returns:

bool

A value indicating whether a part was selected.

SelectNextItem()

Selects the next MaskPart based on the SelectedItemIndex.

public virtual void SelectNextItem()

SelectNextItemFromCurrentCaret()

Selects the next MaskPart based on the caret position.

public virtual void SelectNextItemFromCurrentCaret()

SelectPrevEditableItem()

Selects the previous editable MaskPart in the List.

public virtual void SelectPrevEditableItem()

SelectPrevItem()

Selects the previous MaskPart based on the SelectedItemIndex.

public virtual void SelectPrevItem()

SelectPrevItemFromCurrentCaret()

Selects the previous MaskPart based on the caret position.

public virtual void SelectPrevItemFromCurrentCaret()

ToString(bool, bool)

Gets the string interpretation of the value based on the Mask

public abstract string ToString(bool includePrompt, bool includeLiterals)

Parameters:includePromptbool

Not used.

includeLiteralsbool

not used.

Returns:

string

The string interpretation of the value based on the mask.

Implements: IMaskProvider.ToString(bool, bool)

Validate(string)

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.

public abstract bool Validate(string value)

Parameters:valuestring

THe string value that is about to be set to the Value.

Returns:

bool

A value indicating whether the string value is valid.

Implements: IMaskProvider.Validate(string)

Events

SelectedItemChanged

EventHandler

Occurs when the selected item is changed.

public event EventHandler SelectedItemChanged