jQuery 插件autocomplete自動(dòng)完成應(yīng)用(自動(dòng)補(bǔ)全)(asp.net后臺(tái))

更新時(shí)間：2022年09月06日 17:26:15 作者：Peter

項(xiàng)目中有時(shí)會(huì)用到自動(dòng)補(bǔ)全查詢，就像Google搜索框、淘寶商品搜索功能，輸入漢字或字母，則以該漢字或字母開頭的相關(guān)條目會(huì)顯示出來(lái)供用戶選擇， autocomplete插件就是完成這樣的功能

autocomplete官網(wǎng) ： http://bassistance.de/jquery-plugins/jquery-plugin-autocomplete/ （可下載jQuery autocomplete插件）。

　　淘寶商品搜索功能效果：

下面來(lái)使用 autocomplete插件來(lái)實(shí)現(xiàn)類似效果。

1. 創(chuàng)建 AjaxPage.aspx 頁(yè)面，在其中定義 WebMethod 方法來(lái)返回搜索頁(yè)面需要的輸入框所有提示條目。后臺(tái)代碼如下：

using System.Collections.Generic;
using System.IO;
using System.Runtime.Serialization.Json;
using System.Web.Services;
public partial class AjaxPage : System.Web.UI.Page
{
[WebMethod]
public static string GetAllHints()
{
Dictionary<string, string> data = new Dictionary<string, string>();
data.Add("蘋果4代iphone正品", "21782");
data.Add("蘋果4代 手機(jī)套", "238061");
data.Add("蘋果4", "838360");
data.Add("蘋果皮", "242721");
data.Add("蘋果筆記本", "63348");
data.Add("蘋果4s", "24030");
data.Add("戴爾筆記本", "110105");
data.Add("戴爾手機(jī)", "18870");
data.Add("戴爾鍵盤", "30367");
DataContractJsonSerializer serializer = new DataContractJsonSerializer(data.GetType());
using (MemoryStream ms = new MemoryStream())
{
serializer.WriteObject(ms, data);
return System.Text.Encoding.UTF8.GetString(ms.ToArray());
}
}
}

注：該方法返回的數(shù)據(jù)格式為json字符串。

2. 創(chuàng)建搜索頁(yè)面 Index.aspx，前臺(tái)代碼如下：

<%@ Page Language="C#" AutoEventWireup="true" CodeFile="Index.aspx.cs" Inherits="_Default" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
<title></title>
<link rel="Stylesheet" href="Styles/jquery.autocomplete.css" />
<script type="text/javascript" src="Scripts/jquery-1.4.1.js"></script>
<script type="text/javascript" src="Scripts/jquery.autocomplete.js"></script>
<script type="text/javascript">
var v = 1;
$(document).ready(function () {
$.ajax({
type: "POST",
contentType: "application/json",
url: "AjaxPage.aspx/GetAllHints",
data: "{}",
dataType: "json",
success: function (msg) {
var datas = eval('(' + msg.d + ')');
$("#txtIput").autocomplete(datas, {
formatItem: function (row, i, max) {
return "<table width='400px'><tr><td align='left'>" + row.Key + "</td><td align='right'><font style='color: #009933; font-family: 黑體; font-style: italic'>約" + row.Value + "個(gè)寶貝</font>&nbsp;&nbsp;</td></tr></table>";
},
formatMatch: function(row, i, max){
return row.Key;
}
});
}
});
});
</script>
</head>
<body>
<form id="form1" runat="server">
<div>
<center>
<asp:TextBox ID="txtIput" runat="server" Width="400px"></asp:TextBox>
</center>
</div>
</form>
</body>
</html>

實(shí)現(xiàn)效果如下：

3. autocomplete 參數(shù)說(shuō)明

* minChars (Number)
    在觸發(fā)autoComplete前用戶至少需要輸入的字符數(shù).Default: 1，如果設(shè)為0，在輸入框內(nèi)雙擊或者刪除輸入框內(nèi)內(nèi)容時(shí)顯示列表
* width (Number)
    指定下拉框的寬度. Default: input元素的寬度
* max (Number)
    autoComplete下拉顯示項(xiàng)目的個(gè)數(shù).Default: 10
* delay (Number)
    擊鍵后激活autoComplete的延遲時(shí)間(單位毫秒).Default: 遠(yuǎn)程為400 本地10
* autoFill (Boolean)
    要不要在用戶選擇時(shí)自動(dòng)將用戶當(dāng)前鼠標(biāo)所在的值填入到input框. Default: false
* mustMatch (Booolean)
    如果設(shè)置為true,autoComplete只會(huì)允許匹配的結(jié)果出現(xiàn)在輸入框,所有當(dāng)用戶輸入的是非法字符時(shí)將會(huì)得不到下拉框.Default: false
* matchContains (Boolean)
    決定比較時(shí)是否要在字符串內(nèi)部查看匹配,如ba是否與foo bar中的ba匹配.使用緩存時(shí)比較重要.不要和autofill混用.Default: false
* selectFirst (Boolean)
    如果設(shè)置成true,在用戶鍵入tab或return鍵時(shí)autoComplete下拉列表的第一個(gè)值將被自動(dòng)選擇,盡管它沒(méi)被手工選中(用鍵盤或鼠標(biāo)).當(dāng)然如果用戶選中某個(gè)項(xiàng)目,那么就用用戶選中的值. Default: true
* cacheLength (Number)
    緩存的長(zhǎng)度.即對(duì)從數(shù)據(jù)庫(kù)中取到的結(jié)果集要緩存多少條記錄.設(shè)成1為不緩存.Default: 10
* matchSubset (Boolean)
    autoComplete可不可以使用對(duì)服務(wù)器查詢的緩存,如果緩存對(duì)foo的查詢結(jié)果,那么如果用戶輸入foo就不需要再進(jìn)行檢索了,直接使用緩存.通常是打開這個(gè)選項(xiàng)以減輕服務(wù)器的負(fù)擔(dān)以提高性能.只會(huì)在緩存長(zhǎng)度大于1時(shí)有效.Default: true
* matchCase (Boolean)
    比較是否開啟大小寫敏感開關(guān).使用緩存時(shí)比較重要.如果你理解上一個(gè)選項(xiàng),這個(gè)也就不難理解,就好比f(wàn)oot要不要到FOO的緩存中去找.Default: false
* multiple (Boolean)
    是否允許輸入多個(gè)值即多次使用autoComplete以輸入多個(gè)值. Default: false
* multipleSeparator (String)
    如果是多選時(shí),用來(lái)分開各個(gè)選擇的字符. Default: ","
* scroll (Boolean)
    當(dāng)結(jié)果集大于默認(rèn)高度時(shí)是否使用卷軸顯示 Default: true
* scrollHeight (Number)
    自動(dòng)完成提示的卷軸高度用像素大小表示 Default: 180
* formatItem (Function)
    為每個(gè)要顯示的項(xiàng)目使用高級(jí)標(biāo)簽.即對(duì)結(jié)果中的每一行都會(huì)調(diào)用這個(gè)函數(shù),返回值將用LI元素包含顯示在下拉列表中. Autocompleter會(huì)提供三個(gè)參數(shù)(row, i, max): 返回的結(jié)果數(shù)組, 當(dāng)前處理的行數(shù)(即第幾個(gè)項(xiàng)目,是從1開始的自然數(shù)), 當(dāng)前結(jié)果數(shù)組元素的個(gè)數(shù)即項(xiàng)目的個(gè)數(shù). Default: none, 表示不指定自定義的處理函數(shù),這樣下拉列表中的每一行只包含一個(gè)值.
* formatResult (Function)
    和formatItem類似,但可以將將要輸入到input文本框內(nèi)的值進(jìn)行格式化.同樣有三個(gè)參數(shù),和formatItem一樣.Default: none,表示要么是只有數(shù)據(jù),要么是使用formatItem提供的值.
* formatMatch (Function)
    對(duì)每一行數(shù)據(jù)使用此函數(shù)格式化需要查詢的數(shù)據(jù)格式. 返回值是給內(nèi)部搜索算法使用的. 參數(shù)值row
* extraParams (Object)
    為后臺(tái)(一般是服務(wù)端的腳本)提供更多的參數(shù).和通常的作法一樣是使用一個(gè)鍵值對(duì)對(duì)象.如果傳過(guò)去的值是{ bar:4 },將會(huì)被autocompleter解析成my_autocomplete_backend.php?q=foo&bar=4 (假設(shè)當(dāng)前用戶輸入了foo). Default: {}
* result (handler)
    此事件會(huì)在用戶選中某一項(xiàng)后觸發(fā)，參數(shù)為：
    event: 事件對(duì)象. event.type為result.
    data: 選中的數(shù)據(jù)行.
    formatted:formatResult函數(shù)返回的值
    例如：
    $("#singleBirdRemote").result(function(event, data, formatted) {
        //如選擇后給其他控件賦值，觸發(fā)別的事件等等
    });