DataGridViewMaskedTextBoxColumn

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

• DataGridViewElement
  • DataGridViewBand
    • DataGridViewColumn
      • DataGridViewMaskedTextBoxColumn

Represents a DataGridView column that contains a collection of DataGridViewTextBoxCell cells.

C#

public class DataGridViewMaskedTextBoxColumn : DataGridViewColumn

VB.NET

Public Class DataGridViewMaskedTextBoxColumn
    Inherits DataGridViewColumn

Constructors

DataGridViewMaskedTextBoxColumn()

Initializes a new instance of the DataGridViewMaskedTextBoxColumn.

DataGridViewMaskedTextBoxColumn(cellTemplate)

Initializes a new instance of the DataGridViewMaskedTextBoxColumn.

Name	Type	Description
cellTemplate	DataGridViewMaskedTextBoxCell	An existing DataGridViewMaskedTextBoxCell to use as a template.

Properties

CellTemplate

DataGridViewCell: Returns or sets the template used to model cell appearance.

Throws:

• InvalidOperationException The type is null.
• InvalidCastException The set type is not compatible with type DataGridViewTextBoxCell.

Culture

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

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.

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 DataGridViewMaskedTextBoxColumn 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)

This value is inherited by all the cells in the column that do not specify a value for this property. Throws:

• InvalidOperationException The value of the CellTemplate property is null.

PromptChar

Char: Returns or sets the character used to represent the absence of user input in the cell's 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.

ShowMask

Boolean: Returns or sets whether the empty mask is shown in the cell when the value is null or empty. (Default: True)

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 control.

Implements

Name	Description
IWisejComponent	All wisej components implement this interface.
IWisejSerializable	Allows an object to serialize itself.