DataGridViewMaskedTextBoxCell

Wisej.Web.DataGridViewMaskedTextBoxCell

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

DataGridViewElement
- DataGridViewCell
  - DataGridViewMaskedTextBoxCell

Displays an editable MaskedTextBox control in a DataGridViewCell cell when in edit mode.

public class DataGridViewMaskedTextBoxCell : DataGridViewCell

Public Class DataGridViewMaskedTextBoxCell
    Inherits DataGridViewCell

Constructors

DataGridViewMaskedTextBoxCell()

Initializes a new instance of DataGridViewMaskedTextBoxCell.

Properties

Culture

CultureInfo: Returns or sets the culture information associated with the masked cell.

EditType

Type: Returns the type of the cell's editing control.

Mask

String: Returns or sets the input mask. (Default: "")

The Mask is a string that defines the masking characters and the literals to display and process during user input and when reading the Value property. Server side masking is processed by an instance of the MaskedTextProvider class exposed by the MaskedTextProvider property. On the client side, the mask processing is performed by the "wisej.utils.MaskProvider.js" class while the user edits the input field.

Masking Character	Description
0	Digit, required. This element will accept any single digit between 0 and 9.
9	Digit or space, optional.
#	Digit or space, optional. If this position is blank in the mask, it will be rendered as a space in the Text property. Plus (+) and minus (-) signs are allowed.
L	Letter, required. Restricts input to the ASCII letters a-z and A-Z. This mask element is equivalent to [a-zA-Z] in regular expressions.
?	Letter, optional. Restricts input to the ASCII letters a-z and A-Z. This mask element is equivalent to [a-zA-Z]? in regular expressions.
&	Character, required. This element behaves like the "L" element.
C	Character, optional. Any non-control character. This element behaves like the "?" element.
A	Alphanumeric, required. The only characters it will accept are the ASCII letters a-z and A-Z. This mask element behaves like the "a" element.
a	Alphanumeric, optional. The only characters it will accept are the ASCII letters a-z and A-Z. This mask element behaves like the "A" element.
.	Decimal placeholder. The actual display character used will be the decimal symbol appropriate to the format provider, as determined by the control's FormatProvider property.
,	Thousands placeholder. The actual display character used will be the thousands placeholder appropriate to the format provider, as determined by the control's FormatProvider property.
:	Time separator. The actual display character used will be the time symbol appropriate to the format provider, as determined by the control's FormatProvider property.
/	Date separator. The actual display character used will be the date symbol appropriate to the format provider, as determined by the control's FormatProvider property.
$	Currency symbol. The actual character displayed will be the currency symbol appropriate to the format provider, as determined by the control's FormatProvider property.
<	Shift down. Converts all characters that follow to lowercase.
>	Shift up. Converts all characters that follow to uppercase.

\	Escape. Escapes a mask character, turning it into a literal. "\" is the escape sequence for a backslash.
Others	Literals. All non-mask elements will appear as themselves within MaskedTextBox. Literals always occupy a static position in the mask at run time, and cannot be moved or deleted by the user.

Masking Character

Description

Digit, required. This element will accept any single digit between 0 and 9.

Digit or space, optional.

Digit or space, optional. If this position is blank in the mask, it will be rendered as a space in the Text property. Plus (+) and minus (-) signs are allowed.

Letter, required. Restricts input to the ASCII letters a-z and A-Z. This mask element is equivalent to [a-zA-Z] in regular expressions.

Letter, optional. Restricts input to the ASCII letters a-z and A-Z. This mask element is equivalent to [a-zA-Z]? in regular expressions.

Character, required. This element behaves like the "L" element.

Character, optional. Any non-control character. This element behaves like the "?" element.

Alphanumeric, required. The only characters it will accept are the ASCII letters a-z and A-Z. This mask element behaves like the "a" element.

Alphanumeric, optional. The only characters it will accept are the ASCII letters a-z and A-Z. This mask element behaves like the "A" element.

Decimal placeholder. The actual display character used will be the decimal symbol appropriate to the format provider, as determined by the control's FormatProvider property.

Thousands placeholder. The actual display character used will be the thousands placeholder appropriate to the format provider, as determined by the control's FormatProvider property.

Time separator. The actual display character used will be the time symbol appropriate to the format provider, as determined by the control's FormatProvider property.

Date separator. The actual display character used will be the date symbol appropriate to the format provider, as determined by the control's FormatProvider property.

Currency symbol. The actual character displayed will be the currency symbol appropriate to the format provider, as determined by the control's FormatProvider property.

Shift down. Converts all characters that follow to lowercase.

Shift up. Converts all characters that follow to uppercase.

Escape. Escapes a mask character, turning it into a literal. "\" is the escape sequence for a backslash.

Others

Literals. All non-mask elements will appear as themselves within MaskedTextBox. Literals always occupy a static position in the mask at run time, and cannot be moved or deleted by the user.

If you change the Mask when the control already contains a value, it will apply the new mask to the existing text. The decimal (.), thousand (,), time (:), date (/), and currency ($) symbols default to displaying those symbols as defined by the application's culture. You can force a specific DataGridViewMaskedTextBoxCell them to display symbols for another culture by using the Culture property. Otherwise you can set the application-wide culture by setting the CurrentCulture property.

MaxInputLength

Int32: Returns or sets the maximum number of characters that can be entered into the text box. (Default: 0)

Throws:

ArgumentOutOfRangeException The value is less than 0.

PromptChar

Char: Returns or sets the character used to represent the absence of user input in MaskedTextBox. (Default: _)

Throws:

ArgumentException The character specified when setting this property is not a valid prompt character, as determined by the IsValidPasswordChar method of the MaskedTextProvider class.
InvalidOperationException The prompt character specified is the same as the current password character, PasswordChar. The two are required to be different.

TextMaskFormat

MaskFormat: Returns or sets a value that determines whether literals and prompt characters are included in the formatted string. (Default: IncludeLiterals)

Tools

ComponentToolCollection: Returns the instance of ComponentToolCollection associated with this cell.

ValueType

Type: Returns or sets the data type of the values in the cell.

Methods

InitializeEditingControl(editor, style)

Initializes the control used to edit the cell.

Parameter	Type	Description
editor	Control	The Control that is used to edit the cell.
style	DataGridViewCellStyle	The DataGridViewCellStyle that is in effect for the cell entering edit mode.

Parameter

Type

Description

editor

Control

The Control that is used to edit the cell.

style

DataGridViewCellStyle

The DataGridViewCellStyle that is in effect for the cell entering edit mode.

Throws: