Interface IMaskProvider

Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public interface IMaskProvider

Properties

Culture

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

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

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

IncludePrompt

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

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

true if the prompt character is used to represent the positions where no user input was provided; otherwise, false. The default is true.

Mask

Gets the input mask to use at run time.

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

PromptChar

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

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

The character used to prompt the user for input. The default is an underscore(_).

TextBoxItem

Gets the RadTextBoxItem.

Declaration
RadTextBoxItem TextBoxItem { get; }
Property Value
RadTextBoxItem

Value

Gets or sets the value.

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

Methods

Click()

Occurs when the user clicks with the mouse.

Declaration
bool Click()
Returns
System.Boolean

Not used

Clone()

Clones this instance.

Declaration
IMaskProvider Clone()
Returns
IMaskProvider

The cloned instance.

Delete()

Deletes 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
bool Delete()
Returns
System.Boolean

true

KeyDown(Object, KeyEventArgs)

Occurs when a key is pressed.

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

The sender.
System.Windows.Forms.KeyEventArgs e

Key event arguments.

KeyPress(Object, KeyPressEventArgs)

Occurs when a key is pressed.

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

The sender.
System.Windows.Forms.KeyPressEventArgs e

Key press event arguments.

ToString(Boolean, Boolean)

Gets the string interpretation of the value based on the Mask

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

Not used.
System.Boolean includeLiterals

not used.
Returns
System.String

The string interpretation of the value based on the mask.

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.

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

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

A value indicating whether the string value is valid.

Extension Methods