Documentation

Interface IMaskCharacterProvider

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

Syntax

public interface IMaskCharacterProvider

Properties

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(_).

Methods

Delete()

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.

Declaration
bool Delete()
Returns
System.Boolean

Not used.

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 event arguments.

RemoveAt(Int32, Int32)

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

Declaration
bool RemoveAt(int startPosition, int endPosition)
Parameters
System.Int32 startPosition

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

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

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

Set(String, out Int32, out MaskedTextResultHint)

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

Declaration
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
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.

Extension Methods