Class
NumericMaskTextBoxProvider

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.UI.dll

Syntax:

cs-api-definition
public class NumericMaskTextBoxProvider : IMaskProvider

Inheritance: objectNumericMaskTextBoxProvider

Implements: IMaskProvider

Constructors

NumericMaskTextBoxProvider(string, CultureInfo, RadMaskedEditBoxElement)

Declaration

cs-api-definition
public NumericMaskTextBoxProvider(string mask, CultureInfo culture, RadMaskedEditBoxElement owner)

Parameters

mask

string

culture

CultureInfo

owner

RadMaskedEditBoxElement

Fields

provider

Declaration

cs-api-definition
protected IMaskCharacterProvider provider

Field Value

IMaskCharacterProvider

Properties

Culture

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

Declaration

cs-api-definition
public CultureInfo Culture { get; }

Property Value

CultureInfo

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

Implements IMaskProvider.Culture

IncludePrompt

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

Declaration

cs-api-definition
public bool IncludePrompt { get; set; }

Property Value

bool

Implements IMaskProvider.IncludePrompt

Mask

Gets the input mask.

Declaration

cs-api-definition
public string Mask { get; }

Property Value

string

A string containing the full mask.

Implements IMaskProvider.Mask

PromptChar

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

Declaration

cs-api-definition
public char PromptChar { get; set; }

Property Value

char

The character used to prompt the user for input.

Implements IMaskProvider.PromptChar

TextBoxItem

Gets the text box item.

Declaration

cs-api-definition
public RadTextBoxItem TextBoxItem { get; }

Property Value

RadTextBoxItem

Implements IMaskProvider.TextBoxItem

Value

Gets or sets the value.

Declaration

cs-api-definition
public object Value { get; set; }

Property Value

object

Implements IMaskProvider.Value

Methods

Clone()

Clones this instance.

Declaration

cs-api-definition
public IMaskProvider Clone()

Returns

IMaskProvider

The cloned instance.

Implements IMaskProvider.Clone()

CreateNumericCharacterTextBoxProvider(string, CultureInfo, RadNumericMaskFormatType, RadMaskedEditBoxElement)

Declaration

cs-api-definition
protected virtual IMaskCharacterProvider CreateNumericCharacterTextBoxProvider(string mask, CultureInfo culture, NumericCharacterTextBoxProvider.RadNumericMaskFormatType radNumericMaskFormatType, RadMaskedEditBoxElement owner)

Parameters

mask

string

culture

CultureInfo

radNumericMaskFormatType

NumericCharacterTextBoxProvider.RadNumericMaskFormatType

owner

RadMaskedEditBoxElement

Returns

IMaskCharacterProvider

Delete()

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.

Declaration

cs-api-definition
public bool Delete()

Returns

bool

true

Implements IMaskProvider.Delete()

GetFormat(string, CultureInfo)

Gets the NumericCharacterTextBoxProvider.RadNumericMaskFormatType from the given format string.

Declaration

cs-api-definition
public static NumericCharacterTextBoxProvider.RadNumericMaskFormatType GetFormat(string formatString, CultureInfo culture)

Parameters

formatString

string

The format string.

culture

CultureInfo

The culture.

Returns

NumericCharacterTextBoxProvider.RadNumericMaskFormatType

The NumericCharacterTextBoxProvider.RadNumericMaskFormatType.

KeyDown(object, KeyEventArgs)

Occurs when a key is pressed.

Declaration

cs-api-definition
public void KeyDown(object sender, KeyEventArgs e)

Parameters

sender

object

The sender.

e

KeyEventArgs

Key event arguments.

Implements IMaskProvider.KeyDown(object, KeyEventArgs)

KeyPress(object, KeyPressEventArgs)

Occurs when a key is pressed.

Declaration

cs-api-definition
public void KeyPress(object sender, KeyPressEventArgs e)

Parameters

sender

object

The sender.

e

KeyPressEventArgs

Key event arguments.

Implements IMaskProvider.KeyPress(object, KeyPressEventArgs)

Set(string, out int, out MaskedTextResultHint)

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

Declaration

cs-api-definition
public bool Set(string input, out int testPosition, out MaskedTextResultHint resultHint)

Parameters

input

string

The string value that replaces the existing value.

testPosition

int

Not used.

resultHint

MaskedTextResultHint

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.

ToString(bool, bool)

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

Declaration

cs-api-definition
public string ToString(bool includePrompt, bool includeLiterals)

Parameters

includePrompt

bool

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

includeLiterals

bool

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)

Validate(string)

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

Declaration

cs-api-definition
public bool Validate(string value)

Parameters

value

string

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)