ClassStandardMaskTextBoxProvider
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
public class StandardMaskTextBoxProvider : IMaskProviderInheritance: objectStandardMaskTextBoxProvider
Derived Classes:
Implements:
Constructors
StandardMaskTextBoxProvider(string, CultureInfo, RadMaskedEditBoxElement, bool, char, char, bool)
Initializes a new instance of the StandardMaskTextBoxProvider
Declaration
public StandardMaskTextBoxProvider(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
owner
Declaration
protected RadMaskedEditBoxElement ownerField Value
provider
Declaration
protected StandardCharacterMaskEditBoxProvider providerField Value
Properties
Culture
Gets the culture that determines the value of the localizable separators and placeholders in the input mask.
Declaration
public CultureInfo Culture { get; }Property Value
A System.Globalization.CultureInfo containing the culture information associated with the input mask.
Implements
IncludePrompt
Gets or sets a value indicating whether PromptChar is used to represent the absence of user input when displaying the formatted string.
Declaration
public bool IncludePrompt { get; set; }Property Value
Implements
Mask
Gets the input mask.
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.
TextBoxItem
Gets the text box item.
Declaration
public RadTextBoxItem TextBoxItem { get; }Property Value
RadTextBoxItem
Implements
Methods
Clone()
Clones this instance.
Declaration
public IMaskProvider Clone()Returns
The cloned instance.
Implements
Delete()
Raises a delete operation over the selected text.
KeyDown(object, KeyEventArgs)
Occurs when a key is pressed.
Declaration
public virtual 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 virtual void KeyPress(object sender, KeyPressEventArgs e)Parameters
sender
The sender.
e
Key event arguments.
Implements
Set(string, out int, out MaskedTextResultHint)
Sets 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 if the operation is successful, false if not.
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
TryGetStandardProvider()
Gets the StandardCharacterMaskEditBoxProvider.
Declaration
public virtual StandardCharacterMaskEditBoxProvider TryGetStandardProvider()Returns
Validate(string)
Validates the given string value.