Class StandardCharacterMaskEditBoxProvider

Inheritance
System.Object
StandardCharacterMaskEditBoxProvider
StandartCharacterMaskEditBoxProvider
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class StandardCharacterMaskEditBoxProvider : IMaskCharacterProvider

Constructors

StandardCharacterMaskEditBoxProvider(String, CultureInfo, RadMaskedEditBoxElement, Boolean, Char, Char, Boolean)

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
System.String mask

The mask.
System.Globalization.CultureInfo culture

The culture.
RadMaskedEditBoxElement owner

The owner.
System.Boolean allowPromptAsInput

A value indicating whether the prompt char is allowed as input.
System.Char promptChar

The prompt character.
System.Char passwordChar

The password character.
System.Boolean restrictToAscii

A value indicating whether to restrict the input to ASCII.

Fields

provider

Declaration
protected MaskedTextProvider provider
Field Value
System.ComponentModel.MaskedTextProvider

textBoxItem

Declaration
protected RadTextBoxItem textBoxItem
Field 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
System.Windows.Forms.InsertKeyMode

An System.Windows.Forms.InsertKeyMode value that indicates the current insertion mode. The default is System.Windows.Forms.InsertKeyMode.Default.
Exceptions
System.ComponentModel.InvalidEnumArgumentException

An invalid System.Windows.Forms.InsertKeyMode value was supplied when setting this property.

InternalProvider

Declaration
protected MaskedTextProvider InternalProvider { get; }
Property Value
System.ComponentModel.MaskedTextProvider

IsOverwriteMode

Gets a value that specifies whether new user input overwrites existing input.

Declaration
public bool IsOverwriteMode { get; }
Property Value
System.Boolean

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
public bool MaskCompleted { get; }
Property Value
System.Boolean

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
public bool MaskFull { get; }
Property Value
System.Boolean

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
System.Char

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
public bool ResetOnPrompt { get; set; }
Property Value
System.Boolean

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
public bool ResetOnSpace { get; set; }
Property Value
System.Boolean

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.

Declaration
public bool Delete()
Returns
System.Boolean

true
Implements

KeyDown(Object, KeyEventArgs)

Occurs when a key is pressed.

Declaration
public void KeyDown(object sender, KeyEventArgs e)
Parameters
System.Object sender

The sender.
System.Windows.Forms.KeyEventArgs e

Key event arguments.
Implements

KeyPress(Object, KeyPressEventArgs)

Occurs when a key is pressed.

Declaration
public void KeyPress(object sender, KeyPressEventArgs e)
Parameters
System.Object sender

The sender.
System.Windows.Forms.KeyPressEventArgs e

Key press event arguments.
Implements

OnIsOverwriteModeChanged(EventArgs)

Raises the System.Windows.Forms.MaskedTextBox.IsOverwriteModeChanged event.

Declaration
protected virtual void OnIsOverwriteModeChanged(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs that contains event data.

RemoveAt(Int32, Int32)

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

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

Set(String, out Int32, 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
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
Implements

ToString(Boolean, Boolean)

Returns the formatted string, optionally including prompt and literal characters.

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

Validate(String)

Sets the formatted string to the specified input string.

Declaration
public bool Validate(string value)
Parameters
System.String value

The string value used to set the formatted string.
Returns
System.Boolean

true if all the characters were successfully set; otherwise, false.

Events

IsOverwriteModeChanged

Occurs after the insert mode has changed.

Declaration
public event EventHandler IsOverwriteModeChanged
Event Type
System.EventHandler

Extension Methods