Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
public class StandardCharacterMaskEditBoxProvider : IMaskCharacterProvider
Inheritance: objectStandardCharacterMaskEditBoxProvider
Implements:
Constructors
Initializes a new instance of the StandardCharacterMaskEditBoxProvider class.
public StandardCharacterMaskEditBoxProvider(string mask, CultureInfo culture, RadMaskedEditBoxElement owner, bool allowPromptAsInput, char promptChar, char passwordChar, bool restrictToAscii)
The mask.
cultureCultureInfoThe culture.
ownerRadMaskedEditBoxElementThe owner.
allowPromptAsInputboolA value indicating whether the prompt char is allowed as input.
promptCharcharThe prompt character.
passwordCharcharThe password character.
restrictToAsciiboolA value indicating whether to restrict the input to ASCII.
Fields
protected MaskedTextProvider provider
textBoxItem
RadTextBoxItem
protected RadTextBoxItem textBoxItem
Properties
Gets or sets the text insertion mode of the masked text box control.
public InsertKeyMode InsertKeyMode { get; set; }
An InsertKeyMode value that indicates the current insertion mode. The default is Default.
Exceptions:An invalid InsertKeyMode value was supplied when setting this property.
protected MaskedTextProvider InternalProvider { get; }
Gets a value that specifies whether new user input overwrites existing input.
[Browsable(false)]
public bool IsOverwriteMode { get; }
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.
Gets a value indicating whether all required inputs have been entered into the formatted string.
[Browsable(false)]
public bool MaskCompleted { get; }
true if all required input has been entered into the mask; otherwise, false.
Gets a value indicating whether all required and optional inputs have been entered into the formatted string.
[Browsable(false)]
public bool MaskFull { get; }
true if all required and optional inputs have been entered; otherwise, false.
Gets or sets the character used to represent the absence of user input.
public char PromptChar { get; set; }
The character used to prompt the user for input..
Implements:
Gets or sets a value that determines how an input character that matches the prompt character should be handled.
[Browsable(false)]
public bool ResetOnPrompt { get; set; }
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.
Gets or sets a value that determines how a space input character should be handled.
[Browsable(false)]
public bool ResetOnSpace { get; set; }
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
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.
Occurs when a key is pressed.
public void KeyDown(object sender, KeyEventArgs e)
The sender.
eKeyEventArgsKey event arguments.
Implements:
Occurs when a key is pressed.
public void KeyPress(object sender, KeyPressEventArgs e)
The sender.
eKeyPressEventArgsKey press event arguments.
Implements:
Raises the IsOverwriteModeChanged event.
Removes the assigned characters between the specified positions from the formatted string.
public bool RemoveAt(int startPosition, int endPosition)
The zero-based index of the first assigned character to remove.
endPositionintThe zero-based index of the last assigned character to remove.
Returns:true if the character was successfully removed; otherwise, false.
Implements:
Inserts or replaces the specified string within the formatted string, returning the status of the operation.
public bool Set(string input, out int testPosition, out MaskedTextResultHint resultHint)
The string value that replaces the existing value.
testPositionintNot used.
resultHintMaskedTextResultHintA System.ComponentModel.MaskedTextResultHint that succinctly describes the result of the replacement operation. An output parameter.
Returns:true
Implements:
Returns the formatted string, optionally including prompt and literal characters.
public string ToString(bool includePrompt, bool includeLiterals)
true to include prompt characters in the return string; otherwise, false.
includeLiteralsbooltrue 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:
Events
Occurs after the insert mode has changed.
public event EventHandler IsOverwriteModeChanged