Hide

SftMask/OCX 7.0 - ActiveX Masked Edit Control

Display
Print

Value Property, SftMaskContents Object

Defines a field's contents.

Syntax

Get

VB.NETVal = object.Value(ByVal Index As Short) As Object
VBVal = object.Value(ByVal Index As Integer) As Variant
C#.NETobject Val = object.get_Value(short Index);
VC++_variant_t Val = object->Value[short Index];
_variant_t Val = object->GetValue(short Index);
CHRESULT object->get_Value(short Index, VARIANT* Val);

Put

VB.NETobject.Value(ByVal Index As Short) = Val As Object
VBobject.Value(ByVal Index As Integer) = Val As Variant
C#.NETvoid object.set_Value(short Index, object Val);
VC++_variant_t object->Value[short Index] = Val;
void object->PutValue(short Index, const _variant_t& Val);
CHRESULT object->put_Value(short Index, VARIANT Val);

object

A SftMaskContents object.

Index

The index of the variable as defined using the !number value token (see Mask property).

Val

A Variant defining the contents of the input positions or fields as defined using the !number value token (see Mask property).

Comments

The Value property defines a field's contents.

The Value property can be used to retrieve and set portions of a Masked Edit control's contents without knowing the exact position of the data. The Mask property is defined with the value token !number. Up to 10 value tokens can be used in a single mask.

When setting the Value property, the string defined using Val replaces the current contents of the portion of the mask defined by the matching value token. Based on the ClipMode property, literals may be present. In any case, if characters in the new string Val are not acceptable based on the defined input mask, they are simply ignored.

Date/time input fields can be retrieved and set using the Contents.DateTime property.

Examples

VB.NET

    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

VB6

    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

C#

    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");
}

C++

    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;
    variant_t v = m_pMask1->Contents->Value[0];
    v.ChangeType(VT_BSTR);
    str.Format(_T("The area code is %s"), CString(v.bstrVal));
    AfxMessageBox(str);
    v = m_pMask1->Contents->Value[1];
    v.ChangeType(VT_BSTR);
    str.Format(_T("The exchange is %s"), CString(v.bstrVal));
    AfxMessageBox(str);

See Also SftMaskContents Object | Object Hierarchy


Last Updated 08/13/2020 - (email)
© 2024 Softel vdm, Inc.