jQuery 插件autocomplete 应用

超、凢脫俗 2022-07-14 09:15 248阅读 0赞

# [jQuery 插件autocomplete 应用][jQuery _autocomplete] #

项目中有时会用到自动补全查询，就像Google搜索框、淘宝商品搜索功能，输入汉字或字母，则以该汉字或字母开头的相关条目会显示出来供用户选择， **autocomplete**插件就是完成这样的功能。

**autocomplete官网** ： [http://bassistance.de/jquery-plugins/jquery-plugin-autocomplete/][http_bassistance.de_jquery-plugins_jquery-plugin-autocomplete] （可下载jQuery autocomplete插件）。

淘宝商品搜索功能 效果：

![2011102213452415.png][]

下面来使用 autocomplete插件来实现类似效果。

**1.** 创建 AjaxPage.aspx 页面，在其中定义 WebMethod 方法来返回 搜索页面需要的输入框所有提示条目。 后台代码如下：

![复制代码][copycode.gif]

1 using System.Collections.Generic;
     2 using System.IO;
     3 using System.Runtime.Serialization.Json;
     4 using System.Web.Services;
     5 
     6 public partial class AjaxPage : System.Web.UI.Page
     7 {
     8     [WebMethod]
     9     public static string GetAllHints()
    10     {
    11         Dictionary<string, string> data = new Dictionary<string, string>();
    12         data.Add("苹果4代iphone正品", "21782");
    13         data.Add("苹果4代 手机套", "238061");
    14         data.Add("苹果4", "838360");
    15         data.Add("苹果皮", "242721");
    16         data.Add("苹果笔记本", "63348");
    17         data.Add("苹果4s", "24030");
    18         data.Add("戴尔笔记本", "110105");
    19         data.Add("戴尔手机", "18870");
    20         data.Add("戴尔键盘", "30367");
    21 
    22         DataContractJsonSerializer serializer = new DataContractJsonSerializer(data.GetType());
    23 
    24         using (MemoryStream ms = new MemoryStream())
    25         {
    26             serializer.WriteObject(ms, data);
    27             return System.Text.Encoding.UTF8.GetString(ms.ToArray());
    28         }
    29     }
    30 }

![复制代码][copycode.gif]

注：该方法返回的数据格式为json字符串。

**2.** 创建搜索页面 Index.aspx， 前台代码如下：

![复制代码][copycode.gif]

1 <%@ Page Language="C#" AutoEventWireup="true"  CodeFile="Index.aspx.cs" Inherits="_Default" %>
     2 
     3 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
     4 
     5 <html xmlns="http://www.w3.org/1999/xhtml">
     6 <head runat="server">
     7     <title></title>
     8 <link rel="Stylesheet" href="Styles/jquery.autocomplete.css" />
     9 <script type="text/javascript" src="Scripts/jquery-1.4.1.js"></script>
    10 <script type="text/javascript" src="Scripts/jquery.autocomplete.js"></script>
    11 <script type="text/javascript">
    12     var v = 1;
    13     $(document).ready(function () {
    14         $.ajax({
    15             type: "POST",
    16             contentType: "application/json",
    17             url: "AjaxPage.aspx/GetAllHints",
    18             data: "{}",
    19             dataType: "json",
    20             success: function (msg) {
    21                 var datas = eval('(' + msg.d + ')');
    22                 $("#txtIput").autocomplete(datas, {
    23                     formatItem: function (row, i, max) {
    24                         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 + "个宝贝</font>  </td></tr></table>";
    25                     },
    26                     formatMatch: function(row, i, max){
    27                         return row.Key;
    28                     }
    29                 });
    30             }
    31         });
    32     });
    33 </script>
    34 </head>
    35 <body>
    36     <form id="form1" runat="server">
    37     <div>
    38     <center>
    39         <asp:TextBox ID="txtIput" runat="server" Width="400px"></asp:TextBox>
    40     </center>
    41     </div>
    42     </form>
    43 </body>
    44 </html>

![复制代码][copycode.gif]

实现效果如下：

![2011102214041336.png][]

**3.** autocomplete 参数说明

**\*** minChars (Number)  
    在触发autoComplete前用户至少需要输入的字符数.Default: 1，如果设为0，在输入框内双击或者删除输入框内内容时显示列表  
**\*** width (Number)  
    指定下拉框的宽度. Default: input元素的宽度  
**\*** max (Number)  
    autoComplete下拉显示项目的个数.Default: 10  
**\*** delay (Number)  
    击键后激活autoComplete的延迟时间(单位毫秒).Default: 远程为400 本地10  
**\*** autoFill (Boolean)  
    要不要在用户选择时自动将用户当前鼠标所在的值填入到input框. Default: false  
**\*** mustMatch (Booolean)  
    如果设置为true,autoComplete只会允许匹配的结果出现在输入框,所有当用户输入的是非法字符时将会得不到下拉框.Default: false  
**\*** matchContains (Boolean)  
    决定比较时是否要在字符串内部查看匹配,如ba是否与foo bar中的ba匹配.使用缓存时比较重要.不要和autofill混用.Default: false  
**\*** selectFirst (Boolean)  
    如果设置成true,在用户键入tab或return键时autoComplete下拉列表的第一个值将被自动选择,尽管它没被手工选中(用键盘或鼠标).当然如果用户选中某个项目,那么就用用户选中的值. Default: true  
**\*** cacheLength (Number)  
    缓存的长度.即对从数据库中取到的结果集要缓存多少条记录.设成1为不缓存.Default: 10  
**\*** matchSubset (Boolean)  
    autoComplete可不可以使用对服务器查询的缓存,如果缓存对foo的查询结果,那么如果用户输入foo就不需要再进行检索了,直接使用缓存.通常是打开这个选项以减轻服务器的负担以提高性能.只会在缓存长度大于1时有效.Default: true  
**\*** matchCase (Boolean)  
    比较是否开启大小写敏感开关.使用缓存时比较重要.如果你理解上一个选项,这个也就不难理解,就好比foot要不要到FOO的缓存中去找.Default: false  
**\*** multiple (Boolean)  
    是否允许输入多个值即多次使用autoComplete以输入多个值. Default: false  
**\*** multipleSeparator (String)  
    如果是多选时,用来分开各个选择的字符. Default: ","  
**\*** scroll (Boolean)  
    当结果集大于默认高度时是否使用卷轴显示 Default: true  
**\*** scrollHeight (Number)  
    自动完成提示的卷轴高度用像素大小表示 Default: 180    
**\*** formatItem (Function)  
    为每个要显示的项目使用高级标签.即对结果中的每一行都会调用这个函数,返回值将用LI元素包含显示在下拉列表中. Autocompleter会提供三个参数(row, i, max): 返回的结果数组, 当前处理的行数(即第几个项目,是从1开始的自然数), 当前结果数组元素的个数即项目的个数. Default: none, 表示不指定自定义的处理函数,这样下拉列表中的每一行只包含一个值.  
**\*** formatResult (Function)  
    和formatItem类似,但可以将将要输入到input文本框内的值进行格式化.同样有三个参数,和formatItem一样.Default: none,表示要么是只有数据,要么是使用formatItem提供的值.  
**\*** formatMatch (Function)  
    对每一行数据使用此函数格式化需要查询的数据格式. 返回值是给内部搜索算法使用的. 参数值row  
**\*** extraParams (Object)  
    为后台(一般是服务端的脚本)提供更多的参数.和通常的作法一样是使用一个键值对对象.如果传过去的值是\{ bar:4 \},将会被autocompleter解析成my\_autocomplete\_backend.php?q=foo&bar=4 (假设当前用户输入了foo). Default: \{\}  
**\*** result (handler)  
    此事件会在用户选中某一项后触发，参数为：  
    event: 事件对象. event.type为result.  
    data: 选中的数据行.  
    formatted:formatResult函数返回的值  
    例如：  
    $("\#singleBirdRemote").result(function(event, data, formatted) \{   
        //如选择后给其他控件赋值，触发别的事件等等  
    \});

[jQuery _autocomplete]: http://www.cnblogs.com/Peter-Zhang/archive/2011/10/22/2221147.html
[http_bassistance.de_jquery-plugins_jquery-plugin-autocomplete]: http://bassistance.de/jquery-plugins/jquery-plugin-autocomplete/
[2011102213452415.png]: /images/20220714/de9b0b312c3444ee94bd20bce0ced460.png
[copycode.gif]: /images/20220714/2e3ff93b7b584e23b0bc91a02e7db95c.png
[2011102214041336.png]: /images/20220714/42c1f0cf8da149f39017716feb3398d1.png