AllowPromptAsInput Property

Gets or sets a value that indicates whether PromptChar can be entered as valid data by the user.

Syntax

Visual Basic (Declaration)
Visual Basic (Usage)
C#

<SRDescriptionAttribute("Indicates whether the prompt character is valid as input.")>
<SRCategoryAttribute("Behavior")>
<DefaultValueAttribute()>
Public Property AllowPromptAsInput As Boolean

Dim instance As MaskedTextBoxCell
Dim value As Boolean
 
instance.AllowPromptAsInput = value
 
value = instance.AllowPromptAsInput

[SRDescription("Indicates whether the prompt character is valid as input.")]
[SRCategory("Behavior")]
[DefaultValue()]
public bool AllowPromptAsInput {get; set;}

Property Value

true if the user can enter the prompt character into the cell; otherwise, false. The default is true.

Remarks

Even if AllowPromptAsInput is true, the prompt character must be valid for the current location in the mask in order to be accepted. For example, if PromptChar is "*", and the current location in the mask requires the user to enter a digit, entering an asterisk (*) will fail.

The ResetOnPrompt property takes precedence over AllowPromptAsInput.

Example

This example sets the AllowPromptAsInput property.

GrapeCity.Win.MultiRow.MaskedTextBoxCell mcell = new GrapeCity.Win.MultiRow.MaskedTextBoxCell();
//Type a number
mcell.Mask = "000-0000";
mcell.AllowPromptAsInput = false;
mcell.CutCopyMaskFormat = MaskFormat.IncludePromptAndLiterals;
GrapeCity.Win.MultiRow.TextBoxCell text2 = new GrapeCity.Win.MultiRow.TextBoxCell();
text2.Name = "text2";
GrapeCity.Win.MultiRow.Template template1 = GrapeCity.Win.MultiRow.Template.CreateGridTemplate(new GrapeCity.Win.MultiRow.Cell[] { mcell, text2 }, 160, GrapeCity.Win.MultiRow.AutoGenerateGridTemplateStyles.ColumnHeader | GrapeCity.Win.MultiRow.AutoGenerateGridTemplateStyles.RowHeaderAutoNumber);
template1.ColumnHeaders[0].Cells[0].Value = "Column1";
template1.ColumnHeaders[0].Cells[1].Value = "Column2";
gcMultiRow1.Template = template1;
gcMultiRow1.RowCount = 3;

VB.NET

Dim mcell As New GrapeCity.Win.MultiRow.MaskedTextBoxCell()
'Type a number
mcell.Mask = "000-0000"
mcell.AllowPromptAsInput = False
mcell.CutCopyMaskFormat = MaskFormat.IncludePromptAndLiterals
Dim text2 As New GrapeCity.Win.MultiRow.TextBoxCell()
text2.Name = "text2"
Dim template1 As GrapeCity.Win.MultiRow.Template = GrapeCity.Win.MultiRow.Template.CreateGridTemplate(New GrapeCity.Win.MultiRow.Cell() {mcell, text2}, 160, GrapeCity.Win.MultiRow.AutoGenerateGridTemplateStyles.ColumnHeader Or GrapeCity.Win.MultiRow.AutoGenerateGridTemplateStyles.RowHeaderAutoNumber)
template1.ColumnHeaders(0).Cells(0).Value = "Column1"
template1.ColumnHeaders(0).Cells(1).Value = "Column2"
GcMultiRow1.Template = template1
GcMultiRow1.RowCount = 3

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

MaskedTextBoxCell Class
MaskedTextBoxCell Members