InterfaceIMaskCharacterProvider
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
public interface IMaskCharacterProviderProperties
PromptChar
Gets or sets the character used to represent the absence of user input.
Declaration
char PromptChar { get; set; }Property Value
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.
KeyDown(object, KeyEventArgs)
Occurs when a key is pressed.
Declaration
void KeyDown(object sender, KeyEventArgs e)Parameters
sender
The sender.
e
Key event arguments.
KeyPress(object, KeyPressEventArgs)
Occurs when a key is pressed.
Declaration
void KeyPress(object sender, KeyPressEventArgs e)Parameters
sender
The sender.
e
Key event arguments.
RemoveAt(int, int)
Removes the assigned characters between the specified positions from the formatted string.
Declaration
bool RemoveAt(int startPosition, int endPosition)Parameters
startPosition
The zero-based index of the first assigned character to remove.
endPosition
The zero-based index of the last assigned character to remove.
Returns
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.
Declaration
bool Set(string input, out int testPosition, out MaskedTextResultHint resultHint)Parameters
input
The string value that replaces the existing value.
testPosition
Not used.
resultHint
A System.ComponentModel.MaskedTextResultHint that succinctly describes the result of the replacement operation. An output parameter.
Returns
true if the operation is successful, false if not.
ToString(bool, bool)
Returns the formatted string, optionally including prompt and literal characters.
Declaration
string ToString(bool includePrompt, bool includeLiterals)Parameters
includePrompt
true to include prompt characters in the return string; otherwise, false.
includeLiterals
true to include literal characters in the return string; otherwise, false.
Returns
The formatted System.String that includes all the assigned character values and optionally includes literals and prompts.