Class

RadMaskedEditBoxElement

Initializes a new instance of the RadMaskedEditBoxElement class with no mask applied by default.

Declaration

public RadMaskedEditBoxElement()

Gets or sets a value indicating whether prompt characters are allowed as valid input by the user.

Declaration

public bool AllowPromptAsInput { get; set; }

Property Value

Gets or sets the context menu for the RadMaskedEditBoxElement class.

Declaration

[Browsable(false)]
public RadContextMenu ContextMenu { get; set; }

Property Value

This property is not relevant for this class.

Declaration

[Browsable(false)]
public bool ContextMenuEnabled { get; set; }

Property Value

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

Declaration

public CultureInfo Culture { get; set; }

Property Value

This property is not relevant for this class.

Declaration

[Browsable(false)]
public bool EnableArrowKeys { get; set; }

Property Value

Gets or sets a value indicating whether the selection functionality on mouse click is enabled.

Declaration

public bool EnableClickSelectionStart { get; set; }

Property Value

This property is not relevant for this class.

Declaration

[Browsable(false)]
public bool EnableMouseWheel { get; set; }

Property Value

Gets or sets a value indicating whether end users can set the value to null using keyboard combinations. This can be achieved by pressing Ctrl + Del or Ctrl + 0 key combinations.

Declaration

public virtual bool EnableNullValueInput { get; set; }

Property Value

Gets the result hint position for the last assignment to the Text property.

Declaration

[Browsable(false)]
public int HintPosition { get; }

Property Value

Gets or sets a value indicating whether prompt characters are displayed in the formatted output.

Declaration

public bool IncludePrompt { get; set; }

Property Value

This property is not relevant for this class.

Declaration

[Browsable(false)]
public bool IsKeyBoard { get; }

Property Value

Gets or sets the input mask to use for validating user input.

Declaration

public string Mask { get; set; }

Property Value

Gets or sets the mask type.

Declaration

public virtual MaskType MaskType { get; set; }

Property Value

Gets or sets the maximum date value for DateTime providers.

Declaration

protected DateTime MaxDate { get; set; }

Property Value

Gets or sets the maximum value for TimeSpan providers.

Declaration

protected TimeSpan MaxTimeSpan { get; set; }

Property Value

Gets or sets the minimum date value for DateTime providers.

Declaration

protected DateTime MinDate { get; set; }

Property Value

Gets or sets the minimum value for TimeSpan providers.

Declaration

protected TimeSpan MinTimeSpan { get; set; }

Property Value

Gets or sets the prompt character used to represent missing input positions in the mask.

Declaration

public char PromptChar { get; set; }

Property Value

This property is not relevant for this class.

Declaration

[Browsable(false)]
public IMaskProvider Provider { get; set; }

Property Value

Gets the result hint for the last assignment to the Text property.

Declaration

[Browsable(false)]
public MaskedTextResultHint ResultHint { get; }

Property Value

Gets or sets the selection length that will be applied when EnableClickSelectionStart is enabled and a mouse click occurs.

Declaration

public int SelectionLengthOnMouseClick { get; set; }

Property Value

Gets or sets the selection start position that will be applied when EnableClickSelectionStart is enabled and a mouse click occurs.

Declaration

public int SelectionStartOnMouseClick { get; set; }

Property Value

Gets or sets the text displayed in the control.

Declaration

public override string Text { get; set; }

Property Value

Overrides RadItem.Text

Gets or sets a value that determines whether literals and prompt characters are included in the formatted string.

Declaration

public MaskFormat TextMaskFormat { get; set; }

Property Value

Gets the unmasked copy of the text without formatting characters.

Declaration

[Browsable(false)]
public string UnmaskedText { get; }

Property Value

Gets or sets the value of the RadMaskedEditBoxElement class.

Declaration

public object Value { get; set; }

Property Value

Raises the ValueChanged event when the value has been modified.

Declaration

protected virtual void CallValueChanged(EventArgs e)

Parameters

Raises the ValueChanging event when the value is about to be modified, allowing cancellation.

Declaration

protected virtual void CallValueChanging(CancelEventArgs e)

Parameters

Creates and configures the appropriate mask provider based on the current mask type, culture, and mask settings.

Declaration

protected virtual void CreateMaskProvider()

Disposes of the managed resources used by the masked edit box element.

Declaration

protected override void DisposeManagedResources()

Overrides RadTextBoxElement.DisposeManagedResources()

Decrements the value at the current cursor position based on the mask type.

Declaration

public void Down()

Returns the text value with literal characters excluded but prompt characters included.

Declaration

protected virtual string ExcludeLiterals()

Returns

Returns the text value with prompt characters excluded but literal characters included.

Declaration

protected virtual string ExcludePrompt()

Returns

Returns the text value with both prompt characters and literal characters excluded.

Declaration

protected virtual string ExcludePromptAndLiterals()

Returns

Formats the specified text using the specified mask.

Declaration

public static string Format(string mask, string text)

Parameters

Returns

Formats the specified text using the specified mask and prompt character.

Declaration

public static string Format(string mask, string text, char promptChar)

Parameters

Returns

Formats the specified text using the specified mask, prompt character, and culture information.

Declaration

public static string Format(string mask, string text, char promptChar, CultureInfo culture)

Parameters

Returns

Formats the specified text using the specified mask, prompt character, and culture information, returning detailed result information.

Declaration

public static string Format(string mask, string text, char promptChar, CultureInfo culture, out MaskedTextResultHint hint, out int hintPosition)

Parameters

Returns

Retrieves text content from the system clipboard, supporting both Unicode and standard text formats.

Declaration

public static string GetClipboardText()

Returns

Determines the numeric format type based on a format string and culture.

Declaration

public static NumericCharacterTextBoxProvider.RadNumericMaskFormatType GetFormat(string formatString, CultureInfo culture)

Parameters

Returns

Handles key press events for clipboard operations and other special key combinations.

Declaration

public virtual void HandleKeyPress(KeyPressEventArgs e)

Parameters

Handles the clear button click event by setting the value to null if null value input is enabled, or validating an empty string otherwise.

Declaration

protected override void OnClearButtonClick()

Overrides RadTextBoxElement.OnClearButtonClick()

Raises the MaskProviderCreated event when a new mask provider has been created.

Declaration

protected virtual void OnMaskProviderCreated()

Handles mouse down events to set selection position and length when click selection start is enabled.

Declaration

protected override void OnMouseDown(MouseEventArgs e)

Parameters

Overrides RadTextBoxElement.OnMouseDown(MouseEventArgs)

Removes number formatting characters and symbols based on the current culture and numeric provider type.

Declaration

public string RemoveNumberFormats(string value)

Parameters

Returns

Sets the culture for the masked edit box and recreates the mask provider with the new culture settings.

Declaration

protected virtual void SetCultureCore(CultureInfo value)

Parameters

Handles mouse wheel events to increment or decrement values when mouse wheel is enabled and the control is not read-only.

Declaration

protected virtual void TextBoxItem_MouseWheel(object sender, MouseEventArgs e)

Parameters

Increments the value at the current cursor position based on the mask type.

Declaration

public void Up()

Validates the specified value against the current mask and updates the display.

Declaration

public virtual void Validate(string value)

Parameters

Occurs when the mask provider has been created. This event fires multiple times because the provider is recreated when properties like Mask, Culture, or MaskType change.

Declaration

public event EventHandler MaskProviderCreated

Event Value

Occurs when the editing value has been changed.

Declaration

public event EventHandler ValueChanged

Event Value

Occurs when the editing value is changing and allows cancellation of the change.

Declaration

public event CancelEventHandler ValueChanging

Event Value