Class StandardMaskTextBoxProvider

Inheritance
System.Object
StandardMaskTextBoxProvider
IPMaskTextBoxProvider
StandartMaskTextBoxProvider
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class StandardMaskTextBoxProvider : IMaskProvider

Constructors

StandardMaskTextBoxProvider(String, CultureInfo, RadMaskedEditBoxElement, Boolean, Char, Char, Boolean)

Initializes a new instance of the StandardMaskTextBoxProvider

Declaration
public StandardMaskTextBoxProvider(string mask, CultureInfo culture, RadMaskedEditBoxElement owner, bool allowPromptAsInput, char promptChar, char passwordChar, bool restrictToAscii)
Parameters
System.String mask

The mask.
System.Globalization.CultureInfo culture

The culture.
RadMaskedEditBoxElement owner

The owner.
System.Boolean allowPromptAsInput

A value indicating whether the prompt char is allowed as input.
System.Char promptChar

The prompt character.
System.Char passwordChar

The password character.
System.Boolean restrictToAscii

A value indicating whether to restrict the input to ASCII

Fields

owner

Declaration
protected RadMaskedEditBoxElement owner
Field Value
RadMaskedEditBoxElement

provider

Declaration
protected StandardCharacterMaskEditBoxProvider provider
Field Value
StandardCharacterMaskEditBoxProvider

Properties

Culture

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

Declaration
public CultureInfo Culture { get; }
Property Value
System.Globalization.CultureInfo

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

IncludePrompt

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

Declaration
public bool IncludePrompt { get; set; }
Property Value
System.Boolean

Implements

Mask

Gets the input mask.

Declaration
public string Mask { get; }
Property Value
System.String

A System.String containing the full mask.
Implements

MaskCompleted

Gets a value indicating whether all required inputs have been entered into the formatted string.

Declaration
public bool MaskCompleted { get; }
Property Value
System.Boolean

true if all required input has been entered into the mask; otherwise, false.

MaskFull

Gets a value indicating whether all required and optional inputs have been entered into the formatted string.

Declaration
public bool MaskFull { get; }
Property Value
System.Boolean

true if all required and optional inputs have been entered; otherwise, false.

PromptChar

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

Declaration
public char PromptChar { get; set; }
Property Value
System.Char

The character used to prompt the user for input..
Implements

ResetOnPrompt

Gets or sets a value that determines how an input character that matches the prompt character should be handled.

Declaration
public bool ResetOnPrompt { get; set; }
Property Value
System.Boolean

true if the prompt character entered as input causes the current editable position in the mask to be reset; otherwise, false to indicate that the prompt character is to be processed as a normal input character. The default is true.

ResetOnSpace

Gets or sets a value that determines how a space input character should be handled.

Declaration
public bool ResetOnSpace { get; set; }
Property Value
System.Boolean

true if the space input character causes the current editable position in the mask to be reset; otherwise, false to indicate that it is to be processed as a normal input character. The default is true.

TextBoxItem

Gets the text box item.

Declaration
public RadTextBoxItem TextBoxItem { get; }
Property Value
RadTextBoxItem

Implements

Value

Gets or sets the value.

Declaration
public virtual object Value { get; set; }
Property Value
System.Object

Implements

Methods

Click()

This provider should not implement this method and should thrown an exception.

Declaration
public bool Click()
Returns
System.Boolean

Implements

Clone()

Clones this instance.

Declaration
public IMaskProvider Clone()
Returns
IMaskProvider

The cloned instance.
Implements

Delete()

Raises a delete operation over the selected text.

Declaration
public bool Delete()
Returns
System.Boolean

Implements

KeyDown(Object, KeyEventArgs)

Occurs when a key is pressed.

Declaration
public virtual void KeyDown(object sender, KeyEventArgs e)
Parameters
System.Object sender

The sender.
System.Windows.Forms.KeyEventArgs e

Key event arguments.
Implements

KeyPress(Object, KeyPressEventArgs)

Occurs when a key is pressed.

Declaration
public virtual void KeyPress(object sender, KeyPressEventArgs e)
Parameters
System.Object sender

The sender.
System.Windows.Forms.KeyPressEventArgs e

Key event arguments.
Implements

Set(String, out Int32, out MaskedTextResultHint)

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

Declaration
public bool Set(string input, out int testPosition, out MaskedTextResultHint resultHint)
Parameters
System.String input

The string value that replaces the existing value.
System.Int32 testPosition

Not used.
System.ComponentModel.MaskedTextResultHint resultHint

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

true if the operation is successful, false if not.

ToString(Boolean, Boolean)

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

Declaration
public string ToString(bool includePrompt, bool includeLiterals)
Parameters
System.Boolean includePrompt

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

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

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

TryGetStandardProvider()

Gets the StandardCharacterMaskEditBoxProvider.

Declaration
public virtual StandardCharacterMaskEditBoxProvider TryGetStandardProvider()
Returns
StandardCharacterMaskEditBoxProvider

Validate(String)

Validates the given string value.

Declaration
public virtual bool Validate(string value)
Parameters
System.String value

The value.
Returns
System.Boolean

true if the new value was applied, otherwise false.
Implements

Extension Methods