New to Telerik UI for WinFormsStart a free 30-day trial

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.UI.dll

Syntax:

C#
public class StandardCharacterMaskEditBoxProvider : IMaskCharacterProvider

Inheritance: objectStandardCharacterMaskEditBoxProvider

Implements: IMaskCharacterProvider

Constructors

Initializes a new instance of the StandardCharacterMaskEditBoxProvider class.

C#
public StandardCharacterMaskEditBoxProvider(string mask, CultureInfo culture, RadMaskedEditBoxElement owner, bool allowPromptAsInput, char promptChar, char passwordChar, bool restrictToAscii)
Parameters:maskstring

The mask.

cultureCultureInfo

The culture.

ownerRadMaskedEditBoxElement

The owner.

allowPromptAsInputbool

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

promptCharchar

The prompt character.

passwordCharchar

The password character.

restrictToAsciibool

A value indicating whether to restrict the input to ASCII.

Fields

C#
protected MaskedTextProvider provider

textBoxItem

RadTextBoxItem

C#
protected RadTextBoxItem textBoxItem

Properties

Gets or sets the text insertion mode of the masked text box control.

C#
public InsertKeyMode InsertKeyMode { get; set; }
Property Value:

An InsertKeyMode value that indicates the current insertion mode. The default is Default.

Exceptions:

InvalidEnumArgumentException

An invalid InsertKeyMode value was supplied when setting this property.

C#
protected MaskedTextProvider InternalProvider { get; }

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

C#
[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.

Gets a value indicating whether all required inputs have been entered into the formatted string.

C#
[Browsable(false)]
public bool MaskCompleted { get; }
Property Value:

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.

C#
[Browsable(false)]
public bool MaskFull { get; }
Property Value:

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.

C#
public char PromptChar { get; set; }
Property Value:

The character used to prompt the user for input..

Implements: IMaskCharacterProvider.PromptChar

Gets or sets a value that determines how an input character that matches the prompt character should be handled.

C#
[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.

Gets or sets a value that determines how a space input character should be handled.

C#
[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

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.

C#
public bool Delete()
Returns:

bool

true

Implements: IMaskCharacterProvider.Delete()

Occurs when a key is pressed.

C#
public void KeyDown(object sender, KeyEventArgs e)
Parameters:senderobject

The sender.

eKeyEventArgs

Key event arguments.

Implements: IMaskCharacterProvider.KeyDown(object, KeyEventArgs)

Occurs when a key is pressed.

C#
public void KeyPress(object sender, KeyPressEventArgs e)
Parameters:senderobject

The sender.

eKeyPressEventArgs

Key press event arguments.

Implements: IMaskCharacterProvider.KeyPress(object, KeyPressEventArgs)

Raises the IsOverwriteModeChanged event.

C#
protected virtual void OnIsOverwriteModeChanged(EventArgs e)
Parameters:eEventArgs

An EventArgs that contains event data.

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

C#
public bool RemoveAt(int startPosition, int endPosition)
Parameters:startPositionint

The zero-based index of the first assigned character to remove.

endPositionint

The zero-based index of the last assigned character to remove.

Returns:

bool

true if the character was successfully removed; otherwise, false.

Implements: IMaskCharacterProvider.RemoveAt(int, int)

Inserts or replaces the specified string within the formatted string, returning the status of the operation.

C#
public bool Set(string input, out int testPosition, out MaskedTextResultHint resultHint)
Parameters:inputstring

The string value that replaces the existing value.

testPositionint

Not used.

resultHintMaskedTextResultHint

A System.ComponentModel.MaskedTextResultHint that succinctly describes the result of the replacement operation. An output parameter.

Returns:

bool

true

Implements: IMaskCharacterProvider.Set(string, out int, out MaskedTextResultHint)

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

C#
public string ToString(bool includePrompt, bool includeLiterals)
Parameters:includePromptbool

true to include prompt characters in the return string; otherwise, false.

includeLiteralsbool

true to include literal characters in the return string; otherwise, false.

Returns:

string

The formatted System.String that includes all the assigned character values and optionally includes literals and prompts.

Implements: IMaskCharacterProvider.ToString(bool, bool)

Sets the formatted string to the specified input string.

C#
public bool Validate(string value)
Parameters:valuestring

The string value used to set the formatted string.

Returns:

bool

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

Events

Occurs after the insert mode has changed.

C#
public event EventHandler IsOverwriteModeChanged