SftMask/OCX 7.0 - ActiveX Masked Edit Control

MatchAddCustomItems Event, SftMask Object

The control now accepts custom autocomplete entries.

Syntax

object

A SftMask object.

Count

The number of saved entries displayed in the list autocomplete entries.

Comments

The MatchAddCustomItems event occurs when the control accepts custom autocomplete entries.

The control is about to display the list of saved autocomplete entries. This event occurs so the application can add custom entries using the AutoComplete.AddTop and AddBottom methods.

This event occurs even if the list of saved entries is empty (Count is 0). If the application does not add a custom entry, the list is not displayed.

Custom entries are never saved (see AutoComplete.File property).

If an application adds custom entries, the MatchCustom event must be implemented to perform an action when the user selects a custom entry. There is no default action for custom entries. Custom entries are never used to update the control contents.

While handling this event, the Masked Edit control must not be updated through its methods or properties, except using the AutoComplete.AddTop and AutoComplete.AddBottom methods.

The MatchAddCustomItems event only occurs when AutoComplete.Mode is set to autocompleteSftMaskSuggest. This event does not occur for other modes.

Examples

VB.NET

    AutoCompleteObj.File = "-\Softelvdm\AutoComplete\SampleFile2.Suggest"
    AutoCompleteObj.Encrypt = False
    AutoCompleteObj.IgnoreCase = True
    AutoCompleteObj.MaxEntries = 50
    AutoCompleteObj.Mode = SftMaskAutoCompleteModeConstants.autocompleteSftMaskSuggest
End Sub

Private Sub AxSftMask1_MatchAddCustomItems(ByVal sender As Object, ByVal e As AxSftMaskLib70._ISftMaskEvents_MatchAddCustomItemsEvent) Handles AxSftMask1.MatchAddCustomItems
    ' Ready to add custom items
    AxSftMask1.AutoComplete.AddTop("ZIP-Code Lookup ...", 1)
    AxSftMask1.AutoComplete.AddTop("State Lookup ...", 2)
    If e.count > 6 Then
        AxSftMask1.AutoComplete.AddBottom("ZIP-Code Lookup ...", 2)
        AxSftMask1.AutoComplete.AddBottom("State Lookup ...", 2)
    End If
End Sub

View Entire Sample Code

VB6

    AutoCompleteObj.File = "-\Softelvdm\AutoComplete\SampleFile2.Suggest"
    AutoCompleteObj.Encrypt = False
    AutoCompleteObj.IgnoreCase = True
    AutoCompleteObj.MaxEntries = 50
    AutoCompleteObj.Mode = autocompleteSftMaskSuggest
End Sub

Private Sub SftMask1_MatchAddCustomItems(ByVal Count As Long)
    ' Ready to add custom items
    SftMask1.AutoComplete.AddTop "ZIP-Code Lookup ...", 1
    SftMask1.AutoComplete.AddTop "State Lookup ...", 2
    If Count > 6 Then
        SftMask1.AutoComplete.AddBottom "ZIP-Code Lookup ...", 2
        SftMask1.AutoComplete.AddBottom "State Lookup ...", 2
    End If
End Sub

View Entire Sample Code

C#

    AutoCompleteObj.File = @"-\Softelvdm\AutoComplete\SampleFile2.Suggest";
    AutoCompleteObj.Encrypt = false;
    AutoCompleteObj.IgnoreCase = true;
    AutoCompleteObj.MaxEntries = 50;
    AutoCompleteObj.Mode = SftMaskAutoCompleteModeConstants.autocompleteSftMaskSuggest;
}

private void axSftMask1_MatchAddCustomItems(object sender, AxSftMaskLib70._ISftMaskEvents_MatchAddCustomItemsEvent e)
{
    // Ready to add custom items
    axSftMask1.AutoComplete.AddTop("ZIP-Code Lookup ...", 1);
    axSftMask1.AutoComplete.AddTop("State Lookup ...", 2);
    if (e.count > 6) {
        axSftMask1.AutoComplete.AddBottom("ZIP-Code Lookup ...", 2);
        axSftMask1.AutoComplete.AddBottom("State Lookup ...", 2);
    }

View Entire Sample Code

C++

    pAutoComplete->Encrypt = VARIANT_FALSE;
    pAutoComplete->IgnoreCase = VARIANT_TRUE;
    pAutoComplete->MaxEntries = 50;
    pAutoComplete->Mode = autocompleteSftMaskSuggest;

    return TRUE;
}

void CProject1Dlg::OnMatchAddCustomItemsSftMask1(long Count)
{
    // Ready to add custom items
    m_pMask1->AutoComplete->AddTop(_T("ZIP-Code Lookup ..."), 1);
    m_pMask1->AutoComplete->AddTop(_T("State Lookup ..."), 2);
    if (Count > 6) {
        m_pMask1->AutoComplete->AddBottom(_T("ZIP-Code Lookup ..."), 2);
        m_pMask1->AutoComplete->AddBottom(_T("State Lookup ..."), 2);

View Entire Sample Code

See Also SftMask Events | Object Hierarchy