AddTop Method, SftMaskAutoComplete Object

Adds a custom autocomplete entry at the top of the list.

Syntax

object

A SftMaskAutoComplete object.

EntryText

The text to be added as an entry in the list of suggestions.

EntryType

A numeric value which is used once the user selects and accepts an entry. This value is passed to the MatchCustom event as EntryType argument. This value cannot be 0.

Comments

The AddTop method adds a custom autocomplete entry at the top of the list.

The AddTop and AddBottom methods can only be used while handling a MatchAddCustomItems event.

Custom entries are only available if the AutoComplete.Mode property is defined as autocompleteSftMaskSuggest. Other modes do not support custom entries.

If the user selects and accepts a custom entry, the MatchCustom event occurs.

Examples

VB.NET View entire sample code

    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

VB6 View entire sample code

    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

C# View entire sample code

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

C++ View entire sample code

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

See Also SftMaskAutoComplete Object | Object Hierarchy