ClassStandardCharacterMaskEditBoxProvider
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
public class StandardCharacterMaskEditBoxProvider : IMaskCharacterProviderInheritance: objectStandardCharacterMaskEditBoxProvider
Implements:
Constructors
StandardCharacterMaskEditBoxProvider(string, CultureInfo, RadMaskedEditBoxElement, bool, char, char, bool)
Initializes a new instance of the StandardCharacterMaskEditBoxProvider class.
Declaration
public StandardCharacterMaskEditBoxProvider(string mask, CultureInfo culture, RadMaskedEditBoxElement owner, bool allowPromptAsInput, char promptChar, char passwordChar, bool restrictToAscii)Parameters
mask
The mask.
culture
The culture.
owner
The owner.
allowPromptAsInput
A value indicating whether the prompt char is allowed as input.
promptChar
The prompt character.
passwordChar
The password character.
restrictToAscii
A value indicating whether to restrict the input to ASCII.
Fields
textBoxItem
Declaration
protected RadTextBoxItem textBoxItemField Value
RadTextBoxItem
Properties
InsertKeyMode
Gets or sets the text insertion mode of the masked text box control.
Declaration
public InsertKeyMode InsertKeyMode { get; set; }Property Value
An InsertKeyMode value that indicates the current insertion mode. The default is Default.
Exceptions
An invalid InsertKeyMode value was supplied when setting this property.
InternalProvider
Declaration
protected MaskedTextProvider InternalProvider { get; }Property Value
IsOverwriteMode
Gets a value that specifies whether new user input overwrites existing input.
Declaration
[Browsable(false)]
public bool IsOverwriteMode { get; }Property Value
true if RadMaskedEditBox will overwrite existing characters as the user enters new ones; false if RadMaskedEditBox will shift existing characters forward. The default is false.
MaskCompleted
Gets a value indicating whether all required inputs have been entered into the formatted string.
Declaration
[Browsable(false)]
public bool MaskCompleted { get; }Property Value
true if all required input has been entered into the mask; otherwise, false.
MaskFull
Gets a value indicating whether all required and optional inputs have been entered into the formatted string.
Declaration
[Browsable(false)]
public bool MaskFull { get; }Property Value
true if all required and optional inputs have been entered; otherwise, false.
PromptChar
Gets or sets the character used to represent the absence of user input.
Declaration
public char PromptChar { get; set; }Property Value
The character used to prompt the user for input..
Implements
ResetOnPrompt
Gets or sets a value that determines how an input character that matches the prompt character should be handled.
Declaration
[Browsable(false)]
public bool ResetOnPrompt { get; set; }Property Value
true if the prompt character entered as input causes the current editable position in the mask to be reset; otherwise, false to indicate that the prompt character is to be processed as a normal input character. The default is true.
ResetOnSpace
Gets or sets a value that determines how a space input character should be handled.
Declaration
[Browsable(false)]
public bool ResetOnSpace { get; set; }Property Value
true if the space input character causes the current editable position in the mask to be reset; otherwise, false to indicate that it is to be processed as a normal input character. The default is true.
Methods
Delete()
Raises a delete operation over the 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
public void KeyDown(object sender, KeyEventArgs e)Parameters
sender
The sender.
e
Key event arguments.
Implements
KeyPress(object, KeyPressEventArgs)
Occurs when a key is pressed.
Declaration
public void KeyPress(object sender, KeyPressEventArgs e)Parameters
sender
The sender.
e
Key press event arguments.
Implements
OnIsOverwriteModeChanged(EventArgs)
Raises the IsOverwriteModeChanged event.
RemoveAt(int, int)
Removes the assigned characters between the specified positions from the formatted string.
Declaration
public 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.
Implements
Set(string, out int, out MaskedTextResultHint)
Inserts or replaces the specified string within the formatted string, returning the status of the operation.
Declaration
public 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
Implements
ToString(bool, bool)
Returns the formatted string, optionally including prompt and literal characters.
Declaration
public 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.
Implements
Validate(string)
Sets the formatted string to the specified input string.
Events
IsOverwriteModeChanged
Occurs after the insert mode has changed.
Declaration
public event EventHandler IsOverwriteModeChangedEvent Value