New to Telerik UI for WinFormsStart a free 30-day trial

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.UI.dll

Syntax:

C#
public class NumericMaskTextBoxProvider : IMaskProvider

Inheritance: objectNumericMaskTextBoxProvider

Implements: IMaskProvider

Constructors

C#
public NumericMaskTextBoxProvider(string mask, CultureInfo culture, RadMaskedEditBoxElement owner)
Parameters:maskstringcultureCultureInfoownerRadMaskedEditBoxElement

Fields

C#
protected IMaskCharacterProvider provider

Properties

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

C#
public CultureInfo Culture { get; }
Property Value:

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

Implements: IMaskProvider.Culture

Gets or sets a value indicating whether PromptChar is used to represent the absence of user input when displaying the formatted string.

C#
public bool IncludePrompt { get; set; }

Implements: IMaskProvider.IncludePrompt

Gets the input mask.

C#
public string Mask { get; }
Property Value:

A string containing the full mask.

Implements: IMaskProvider.Mask

Gets or sets the character used to represent the absence of user input.

C#
public char PromptChar { get; set; }
Property Value:

The character used to prompt the user for input.

Implements: IMaskProvider.PromptChar

TextBoxItem

RadTextBoxItem

Gets the text box item.

C#
public RadTextBoxItem TextBoxItem { get; }

Implements: IMaskProvider.TextBoxItem

Gets or sets the value.

C#
public object Value { get; set; }

Implements: IMaskProvider.Value

Methods

Clones this instance.

C#
public IMaskProvider Clone()
Returns:

IMaskProvider

The cloned instance.

Implements: IMaskProvider.Clone()

C#
protected virtual IMaskCharacterProvider CreateNumericCharacterTextBoxProvider(string mask, CultureInfo culture, NumericCharacterTextBoxProvider.RadNumericMaskFormatType radNumericMaskFormatType, RadMaskedEditBoxElement owner)
Parameters:maskstringcultureCultureInforadNumericMaskFormatTypeNumericCharacterTextBoxProvider.RadNumericMaskFormatTypeownerRadMaskedEditBoxElementReturns:

IMaskCharacterProvider

Raises a delete operation over the selected text. If there is no selection, deletes the first symbol after the cursor. If there is no selection and the cursor is after the last character, does not remove anything.

C#
public bool Delete()
Returns:

bool

true

Implements: IMaskProvider.Delete()

Gets the NumericCharacterTextBoxProvider.RadNumericMaskFormatType from the given format string.

C#
public static NumericCharacterTextBoxProvider.RadNumericMaskFormatType GetFormat(string formatString, CultureInfo culture)
Parameters:formatStringstring

The format string.

cultureCultureInfo

The culture.

Returns:

NumericCharacterTextBoxProvider.RadNumericMaskFormatType

The NumericCharacterTextBoxProvider.RadNumericMaskFormatType.

Occurs when a key is pressed.

C#
public void KeyDown(object sender, KeyEventArgs e)
Parameters:senderobject

The sender.

eKeyEventArgs

Key event arguments.

Implements: IMaskProvider.KeyDown(object, KeyEventArgs)

Occurs when a key is pressed.

C#
public void KeyPress(object sender, KeyPressEventArgs e)
Parameters:senderobject

The sender.

eKeyPressEventArgs

Key event arguments.

Implements: IMaskProvider.KeyPress(object, KeyPressEventArgs)

Sets the specified string within the formatted string, returning the status of the operation.

C#
public bool Set(string input, out int testPosition, out MaskedTextResultHint resultHint)
Parameters:inputstring

The string value that replaces the existing value.

testPositionint

Not used.

resultHintMaskedTextResultHint

A System.ComponentModel.MaskedTextResultHint that succinctly describes the result of the replacement operation. An output parameter.

Returns:

bool

true if the operation is successful, false if not.

Returns the formatted string, optionally including prompt and literal characters.

C#
public string ToString(bool includePrompt, bool includeLiterals)
Parameters:includePromptbool

true to include prompt characters in the return string; otherwise, false.

includeLiteralsbool

true to include literal characters in the return string; otherwise, false.

Returns:

string

The formatted System.String that includes all the assigned character values and optionally includes literals and prompts.

Implements: IMaskProvider.ToString(bool, bool)

Validates the given string value and sets it as Value if the value is valid.

C#
public 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)