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

IMaskCharacterProvider

Interface

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.UI.dll

Syntax:

public interface IMaskCharacterProvider

Derived Classes: NumericCharacterTextBoxProviderStandardCharacterMaskEditBoxProvider

Properties

PromptChar

char

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

char PromptChar { get; set; }

Property Value:

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

Raises the delete operation for currently selected mask part. 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.

bool Delete()

Returns:

bool

Not used.

KeyDown(object, KeyEventArgs)

Occurs when a key is pressed.

void KeyDown(object sender, KeyEventArgs e)

Parameters:senderobject

The sender.

eKeyEventArgs

Key event arguments.

KeyPress(object, KeyPressEventArgs)

Occurs when a key is pressed.

void KeyPress(object sender, KeyPressEventArgs e)

Parameters:senderobject

The sender.

eKeyPressEventArgs

Key event arguments.

RemoveAt(int, int)

Removes the assigned characters between the specified positions from the formatted string.

bool RemoveAt(int startPosition, int endPosition)

Parameters:startPositionint

The zero-based index of the first assigned character to remove.

endPositionint

The zero-based index of the last assigned character to remove.

Returns:

bool

true if the character was successfully removed; otherwise, false.

Set(string, out int, out MaskedTextResultHint)

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

bool Set(string input, out int testPosition, out MaskedTextResultHint resultHint)

Parameters:inputstring

The string value that replaces the existing value.

testPositionint

Not used.

resultHintMaskedTextResultHint

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.

string ToString(bool includePrompt, bool includeLiterals)

Parameters:includePromptbool

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

includeLiteralsbool

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.