Interface
IMaskProvider

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.UI.dll

Syntax:

cs-api-definition
public interface IMaskProvider

Properties

Culture

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

Declaration

cs-api-definition
CultureInfo Culture { get; }

Property Value

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

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

Property Value

bool

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

cs-api-definition
string Mask { get; }

Property Value

string

PromptChar

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

Declaration

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

Property Value

char

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

TextBoxItem

Gets the RadTextBoxItem.

Declaration

cs-api-definition
RadTextBoxItem TextBoxItem { get; }

Property Value

RadTextBoxItem

Value

Gets or sets the value.

Declaration

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

Property Value

object

Methods

Click()

Occurs when the user clicks with the mouse.

Declaration

cs-api-definition
bool Click()

Returns

bool

Not used

Clone()

Clones this instance.

Declaration

cs-api-definition
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

cs-api-definition
bool Delete()

Returns

bool

true

KeyDown(object, KeyEventArgs)

Occurs when a key is pressed.

Declaration

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

Parameters

sender

object

The sender.

e

KeyEventArgs

Key event arguments.

KeyPress(object, KeyPressEventArgs)

Occurs when a key is pressed.

Declaration

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

Parameters

sender

object

The sender.

e

KeyPressEventArgs

Key press event arguments.

ToString(bool, bool)

Gets the string interpretation of the value based on the Mask

Declaration

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

Parameters

includePrompt

bool

Not used.

includeLiterals

bool

not used.

Returns

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

cs-api-definition
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.