SftMask/OCX 7.0 - ActiveX Masked Edit Control

Text Property, SftMaskCaption Object

Defines the caption text.

Syntax

Get

Put

object

A SftMaskCaption object.

String

Defines the caption text.

Comments

The Text property defines the caption text.

The caption can include an accelerator key. By using the & character in the Text property, the following character becomes an accelerator key. If the user types Alt plus the defined accelerator key, the control receives the input focus. For example, if the Text property is set to "Today's &Date", the displayed caption will read "Today's Date", i.e., the D is underlined. If the user types Alt+d, the edit control receives the input focus. To display an & character use "&&".

The caption area position and size are defined using a combination of the Caption.SizePercent or Caption.Width, Caption.Position and AutoSize properties. For a detailed description of the various combinations, please see the chapter Built-In Caption.

Examples

VB.NET

Private Sub Form1_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
    AxSftMask1.Mask = "(!0###!!) !1###!!\-!2####!!"
    AxSftMask1.Caption.Text = "&Phone Number: "
    AxSftMask1.Caption.SizePercent = 40
    AxSftMask1.Caption.Alignment = SftMaskAlignConstants.alignSftMaskRight
    AxSftMask1.Caption.Position = SftMaskPositionConstants.positionSftMaskLeft
    AxSftMask1.Caption.VerticalAlignment = SftMaskVerticalAlignConstants.valignSftMaskBaseline
    AxSftMask1.AutoSize = True
    AxSftMask1.Text = "9415058600"
    MsgBox("The area code is " & AxSftMask1.Contents.Value(0))
    MsgBox("The exchange is " & AxSftMask1.Contents.Value(1))
    MsgBox("The last 4 digits are " & AxSftMask1.Contents.Value(2))
    AxSftMask1.Contents.Value(2) = "8555"
End Sub

View Entire Sample Code

VB6

Private Sub Form_Load()
    SftMask1.Mask = "(!0###!!) !1###!!\-!2####!!"
    SftMask1.Caption.Text = "&Phone Number: "
    SftMask1.Caption.SizePercent = 40
    SftMask1.Caption.Alignment = alignSftMaskRight
    SftMask1.Caption.Position = positionSftMaskLeft
    SftMask1.Caption.VerticalAlignment = valignSftMaskBaseline
    SftMask1.AutoSize = True
    SftMask1.Text = "9415058600"
    MsgBox ("The area code is " & SftMask1.Contents.Value(0))
    MsgBox ("The exchange is " & SftMask1.Contents.Value(1))
    MsgBox ("The last 4 digits are " & SftMask1.Contents.Value(2))
    SftMask1.Contents.Value(2) = "8555"
End Sub

View Entire Sample Code

C#

private void Form1_Load(object sender, System.EventArgs e)
{
    axSftMask1.Mask = @"(!0###!!) !1###!!\-!2####!!";
    axSftMask1.Caption.Text = "&Phone Number: ";
    axSftMask1.Caption.SizePercent = 40;
    axSftMask1.Caption.Alignment = SftMaskAlignConstants.alignSftMaskRight;
    axSftMask1.Caption.Position = SftMaskPositionConstants.positionSftMaskLeft;
    axSftMask1.Caption.VerticalAlignment = SftMaskVerticalAlignConstants.valignSftMaskBaseline;
    axSftMask1.AutoSize = true;
    axSftMask1.Text = "9415058600";
    MessageBox.Show("The area code is " + axSftMask1.Contents.get_Value(0).ToString());
    MessageBox.Show("The exchange is " + axSftMask1.Contents.get_Value(1).ToString());
    MessageBox.Show("The last 4 digits are " + axSftMask1.Contents.get_Value(2).ToString());
    axSftMask1.Contents.set_Value(2, "8555");
}

View Entire Sample Code

C++

BOOL CProject1Dlg::OnInitDialog()
{
    CDialog::OnInitDialog();

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

    m_pMask1->Mask = _T("(!0###!!) !1###!!\\-!2####!!");
    m_pMask1->Caption->Text = _T("&Phone Number: ");
    m_pMask1->Caption->SizePercent = 40;
    m_pMask1->Caption->Alignment = alignSftMaskRight;
    m_pMask1->Caption->Position = positionSftMaskLeft;
    m_pMask1->Caption->VerticalAlignment = valignSftMaskBaseline;
    m_pMask1->AutoSize = VARIANT_TRUE;
    m_pMask1->Text = _T("9415058600");
    CString str;

View Entire Sample Code

See Also SftMaskCaption Object | Object Hierarchy