PromptChar Property, SftMask Object

Defines the character used to prompt for input data.

Syntax

Get

Put

object

A SftMask object.

Prompt

Defines the character used to prompt for input data. Only one single character can be specified. If an empty string is specified, the space (" ") character is used.

Comments

The PromptChar property defines the character used to prompt for input data.

The character defined using the PromptChar property is displayed in input fields where data has not yet been entered. It is a placeholder for "missing" or unspecified data. It is possible to use the underline character ("_") to visually indicate that the data has not yet been entered, but usually the PromptUnderline property should be used instead.

The PromptChar property has no effect if the control is used as a simple edit control (without Mask).

Examples

C# View entire sample code

private void Form1_Load(object sender, System.EventArgs e)
{
    axSftMask1.Caption.Text = "Pin &Code:";
    axSftMask1.Mask = "<p####>";
    axSftMask1.PromptChar = "0";
    axSftMask1.PromptUnderline = false;
    axSftMask1.PromptUnderlineNoFocus = true;
    axSftMask1.PswdChar = "*";
}

VB.NET View entire sample code

Private Sub Form1_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
    AxSftMask1.Caption.Text = "Pin &Code:"
    AxSftMask1.Mask = "<p####>"
    AxSftMask1.PromptChar = "0"
    AxSftMask1.PromptUnderline = False
    AxSftMask1.PromptUnderlineNoFocus = True
    AxSftMask1.PswdChar = "*"
End Sub

C++ View entire sample code

{
    CDialog::OnInitDialog();

    m_pMask1 = m_Mask1.GetControlUnknown();
    _ASSERT(m_pMask1 != NULL);

    m_pMask1->Caption->Text = _T("Pin &Code:");
    m_pMask1->Mask = _T("<p####>");
    m_pMask1->PromptChar = _T("0");
    m_pMask1->PromptUnderline = VARIANT_FALSE;
    m_pMask1->PromptUnderlineNoFocus = VARIANT_TRUE;
    m_pMask1->PswdChar = _T("*");

    return TRUE;
}

See Also SftMask Object | Object Hierarchy