# DataGridViewMaskedTextBoxColumn Namespace: **Wisej.Web** Assembly: **Wisej.Framework** (4.0.0.0) * [DataGridViewElement](https://docs.wisej.com/api/wisej.web/lists-and-grids/datagridview/wisej.web.datagridviewelement) * [DataGridViewBand](https://docs.wisej.com/api/wisej.web/lists-and-grids/datagridview/wisej.web.datagridviewband) * [DataGridViewColumn](https://docs.wisej.com/api/wisej.web/lists-and-grids/datagridview/wisej.web.datagridviewcolumn) * [DataGridViewMaskedTextBoxColumn](https://docs.wisej.com/api/wisej.web/lists-and-grids/datagridview/wisej.web.datagridviewmaskedtextboxcolumn) Represents a [DataGridView](https://docs.wisej.com/api/wisej.web/lists-and-grids/datagridview) column that contains a collection of [DataGridViewTextBoxCell](https://docs.wisej.com/api/wisej.web/lists-and-grids/datagridview/wisej.web.datagridviewtextboxcell) cells. {% tabs %} {% tab title="C#" %} ```csharp public class DataGridViewMaskedTextBoxColumn : DataGridViewColumn ``` {% endtab %} {% tab title="VB.NET" %} ```visual-basic Public Class DataGridViewMaskedTextBoxColumn Inherits DataGridViewColumn ``` {% endtab %} {% endtabs %} ## Constructors ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) DataGridViewMaskedTextBoxColumn() Initializes a new instance of the [DataGridViewMaskedTextBoxColumn](https://docs.wisej.com/api/wisej.web/lists-and-grids/datagridview/wisej.web.datagridviewmaskedtextboxcolumn). ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) DataGridViewMaskedTextBoxColumn(cellTemplate) Initializes a new instance of the [DataGridViewMaskedTextBoxColumn](https://docs.wisej.com/api/wisej.web/lists-and-grids/datagridview/wisej.web.datagridviewmaskedtextboxcolumn). | Name | Type | Description | | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **cellTemplate** | [DataGridViewMaskedTextBoxCell](https://docs.wisej.com/api/wisej.web/lists-and-grids/datagridview/wisej.web.datagridviewmaskedtextboxcell) | An existing [DataGridViewMaskedTextBoxCell](https://docs.wisej.com/api/wisej.web/lists-and-grids/datagridview/wisej.web.datagridviewmaskedtextboxcell) to use as a template. | ## Properties ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) CellTemplate [DataGridViewCell](https://docs.wisej.com/api/wisej.web/lists-and-grids/datagridview/wisej.web.datagridviewcell): Returns or sets the template used to model cell appearance. **Throws:** * [InvalidOperationException](https://docs.microsoft.com/dotnet/api/system.invalidoperationexception)\ The type is null. * [InvalidCastException](https://docs.microsoft.com/dotnet/api/system.invalidcastexception)\ The set type is not compatible with type [DataGridViewTextBoxCell](https://docs.wisej.com/api/wisej.web/lists-and-grids/datagridview/wisej.web.datagridviewtextboxcell). ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) Culture [CultureInfo](https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo): Returns or sets the culture information associated with the masked cell. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) Mask [String](https://docs.microsoft.com/dotnet/api/system.string): Returns or sets the input mask. (Default: `""`) The [Mask](#mask) is a string that defines the masking characters and the literals to display and process during user input and when reading the [Value](https://docs.wisej.com/api/wisej.web/lists-and-grids/wisej.web.datagridviewcell#value) property.\ Server side masking is processed by an instance of the [MaskedTextProvider](https://docs.microsoft.com/dotnet/api/system.componentmodel.maskedtextprovider) class exposed by the [MaskedTextProvider](#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](#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](https://docs.wisej.com/api/wisej.web/lists-and-grids/datagridview/wisej.web.datagridviewmaskedtextboxcolumn) them to display symbols for another culture by using the [Culture](#culture) property. Otherwise you can set the application-wide culture by setting the [CurrentCulture](https://docs.wisej.com/api/general/application#currentculture) property. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) MaxInputLength [Int32](https://docs.microsoft.com/dotnet/api/system.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](https://docs.microsoft.com/dotnet/api/system.invalidoperationexception)\ The value of the [CellTemplate](#celltemplate) property is null. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) PromptChar [Char](https://docs.microsoft.com/dotnet/api/system.char): Returns or sets the character used to represent the absence of user input in the cell's [MaskedTextBox](https://docs.wisej.com/api/wisej.web/editors/maskedtextbox). (Default: `_`) **Throws:** * [ArgumentException](https://docs.microsoft.com/dotnet/api/system.argumentexception)\ The character specified when setting this property is not a valid prompt character, as determined by the [IsValidPasswordChar](https://docs.microsoft.com/dotnet/api/system.componentmodel.maskedtextprovider.isvalidpasswordchar\(system.char\)) method of the [MaskedTextProvider](https://docs.microsoft.com/dotnet/api/system.componentmodel.maskedtextprovider) class. * [InvalidOperationException](https://docs.microsoft.com/dotnet/api/system.invalidoperationexception)\ The prompt character specified is the same as the current password character, [PasswordChar](https://docs.wisej.com/api/editors/maskedtextbox#passwordchar). The two are required to be different. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) ShowMask [Boolean](https://docs.microsoft.com/dotnet/api/system.boolean): Returns or sets whether the empty mask is shown in the cell when the value is null or empty. (Default: `True`) ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) TextMaskFormat [MaskFormat](https://docs.wisej.com/api/wisej.web/enumerations/wisej.web.maskformat): Returns or sets a value that determines whether literals and prompt characters are included in the formatted string. (Default: `IncludeLiterals`) ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) Tools [ComponentToolCollection](https://docs.wisej.com/api/wisej.web/editors/wisej.web.componenttoolcollection): Returns the instance of [ComponentToolCollection](https://docs.wisej.com/api/wisej.web/editors/wisej.web.componenttoolcollection) associated with this control. ## Implements | Name | Description | | ---------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | | [IUserData](https://docs.wisej.com/api/wisej.web/interfaces/wisej.web.iuserdata) | Provides access to the `UserData` and `Tag` properties associated to the component implementing this interface. | | [IWisejComponent](https://docs.wisej.com/api/wisej.core/interfaces/wisej.core.iwisejcomponent) | All wisej components implement this interface. | | [IWisejSerializable](https://docs.wisej.com/api/wisej.core/interfaces/wisej.core.iwisejserializable) | Allows an object to serialize itself. |