New to Telerik UI for WinForms? Start a free 30-day trial

IMaskProvider

Interface

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.UI.dll

Syntax:

C#

public interface IMaskProvider

Derived Classes: ArabicMaskDateTimeProviderBaseMaskDateProviderEMailMaskTextBoxProviderFreeFormDateTimeProviderIPMaskTextBoxProviderMaskDateTimeProviderMaskTimeSpanProviderNumericMaskTextBoxProviderRegexMaskTextBoxProviderStandardMaskTextBoxProviderTextBoxProvider...

Properties

Culture

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

C#

CultureInfo Culture { get; }

Property Value:

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.

C#

bool IncludePrompt { get; set; }

Property Value:

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.

C#

string Mask { get; }

PromptChar

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

C#

char PromptChar { get; set; }

Property Value:

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

TextBoxItem

RadTextBoxItem

Gets the RadTextBoxItem.

C#

RadTextBoxItem TextBoxItem { get; }

Value

Gets or sets the value.

C#

object Value { get; set; }

Methods

Click()

Occurs when the user clicks with the mouse.

C#

bool Click()

Returns:

Not used

Clone()

Clones this instance.

C#

IMaskProvider Clone()

Returns:

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.

C#

bool Delete()

Returns:

true

KeyDown(object, KeyEventArgs)

Occurs when a key is pressed.

C#

void KeyDown(object sender, KeyEventArgs e)

Parameters:senderobject

The sender.

Key event arguments.

KeyPress(object, KeyPressEventArgs)

Occurs when a key is pressed.

C#

void KeyPress(object sender, KeyPressEventArgs e)

Parameters:senderobject

The sender.

eKeyPressEventArgs

Key press event arguments.

ToString(bool, bool)

Gets the string interpretation of the value based on the Mask

C#

string ToString(bool includePrompt, bool includeLiterals)

Parameters:includePromptbool

Not used.

includeLiteralsbool

not used.

Returns:

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.

C#

bool Validate(string value)

Parameters:valuestring

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

Returns:

A value indicating whether the string value is valid.

In this article

Definition Properties Culture IncludePrompt Mask PromptChar TextBoxItem Value Methods Click()Clone()Delete()KeyDown(object, KeyEventArgs)KeyPress(object, KeyPressEventArgs)ToString(bool, bool)Validate(string)

Not finding the help you need?

Contact Support