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 StandardMaskTextBoxProvider : IMaskProvider

Inheritance: objectStandardMaskTextBoxProvider

Derived Classes: IPMaskTextBoxProvider

Implements: IMaskProvider

Constructors

Initializes a new instance of the StandardMaskTextBoxProvider

C#
public StandardMaskTextBoxProvider(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 RadMaskedEditBoxElement owner
C#
protected StandardCharacterMaskEditBoxProvider provider

Properties

Gets the culture that determines the value of the localizable separators and placeholders in the input mask.

C#
public CultureInfo Culture { get; }
Property Value:

A System.Globalization.CultureInfo containing the culture information associated with the input mask.

Implements: IMaskProvider.Culture

Gets or sets a value indicating whether PromptChar is used to represent the absence of user input when displaying the formatted string.

C#
public bool IncludePrompt { get; set; }

Implements: IMaskProvider.IncludePrompt

Gets the input mask.

C#
public string Mask { get; }
Property Value:

A string containing the full mask.

Implements: IMaskProvider.Mask

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: IMaskProvider.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.

TextBoxItem

RadTextBoxItem

Gets the text box item.

C#
public RadTextBoxItem TextBoxItem { get; }

Implements: IMaskProvider.TextBoxItem

Gets or sets the value.

C#
public virtual object Value { get; set; }

Implements: IMaskProvider.Value

Methods

Clones this instance.

C#
public IMaskProvider Clone()
Returns:

IMaskProvider

The cloned instance.

Implements: IMaskProvider.Clone()

Raises a delete operation over the selected text.

C#
public bool Delete()
Returns:

bool

Implements: IMaskProvider.Delete()

Occurs when a key is pressed.

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

The sender.

eKeyEventArgs

Key event arguments.

Implements: IMaskProvider.KeyDown(object, KeyEventArgs)

Occurs when a key is pressed.

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

The sender.

eKeyPressEventArgs

Key event arguments.

Implements: IMaskProvider.KeyPress(object, KeyPressEventArgs)

Sets 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 if the operation is successful, false if not.

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: IMaskProvider.ToString(bool, bool)

C#
public virtual StandardCharacterMaskEditBoxProvider TryGetStandardProvider()
Returns:

StandardCharacterMaskEditBoxProvider

Validates the given string value.

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

The value.

Returns:

bool

true if the new value was applied, otherwise false.

Implements: IMaskProvider.Validate(string)