jqGrid 是一个用来显示网格数据的jQuery插件，通过使用jqGrid可以轻松实现前端页面与后台数据的ajax异步通信。

一、要引用的文件

要使用jqGrid，首先页面上要引入如下css与js文件。

1、css

2、js

二、使用要点说明

1、获取值

（1）、获取单个id

获取行号，有这种方式：

但是经过实际验证，这种方式不可行，当选中行，再点击同一行会出现获取不到行号的情况。

最后先在js最外部定义一个变量selId，然后使用如下代码在选中行时赋值：

（2）、获取多个选中行的id

其输出格式是逗号分隔的id，如：

1,2,3,4,5

（3）、获得所有行的ID数组

（4）、获取行数据

如果想获取选择的行的数据，只要传入rowId即可，如下：

而这个rowData是一个对象，如果要获取选择的行的这个对象的属性值，如name的值，需如下：

（5）、获取单元格数据

（6）、设定行选中

2、自定义 分页、数据交互

何谓自定义？就是允许你用你自己喜欢的js对象与后端做数据交互。如jsonReader。

如果这个地方的Id设置错了，那么jqGrid就会自动以行号作为Id，这样会影响删除的。如果根据Id来删，很有可能删错行。

这样一来，对于数据表格，在C#中，我可以用一个泛型类，就能够与jqGrid表格进行交互(其中，包括了分页信息，数据内容)。

/// 分页 viewmodel /// public class jQGrid where T : class { public jQGrid() { }

///

/// 带4个参数的构造函数
///

/// <param name="rows">每页显示行数
/// <param name="currentPage">当前页
/// <param name="totalRecord">结果总记录数
/// <param name="jsonArray">JSON数据
public jQGrid(int rows,int currentPage,int totalRecord,IList jsonArray)
{
TotalPage = this.CalculateTotalPage(rows,totalRecord);
CurrentPage = currentPage;
TotalRecord = totalRecord;
JsonArray = jsonArray;
}

public int TotalPage { get; set; }
public int CurrentPage { get; set; }
public int TotalRecord { get; set; }
public IList JsonArray { get; set; }

///

/// 根据每页显示数与总记录数计算出总页数
///

/// <param name="rows">每页显示数
/// <param name="totalRecord">结果总记录数
///
public int CalculateTotalPage(int rows,int totalRecord)
{
return Convert.ToInt32(Math.Ceiling((double)totalRecord / (double)rows));
}
}

3、搜索的实现

搜索的实现主要通过jqGrid的postData像服务器端传递参数。

搜索功能主要通过postData向服务器端传递数据。后端获取参数从而进行处理：

DicParam = new Dictionary(); 　　string Param = Convert.ToString(Request["Param"]); 　　if (!string.IsNullOrEmpty(Param)) 　　{ 　　　　System.Web.Script.Serialization.JavaScriptSerializer sr = new System.Web.Script.Serialization.JavaScriptSerializer(); 　　　　DicParam = sr.Deserialize(Param,typeof(Dictionary)) as Dictionary; 　　}

这样就获取到了查询参数的键值对，至于参数怎么用，一般都是用于sql的where子句。

三、更多jqGrid配置属性说明

1、属性

参数名称类型描述默认值是否可以被修改ajaxGridOptionsobject对ajax参数进行全局设置，可以覆盖ajax事件：error，complete 和 beforeSend空值是ajaxGridOptionsobject对ajax参数进行全局设置空值是ajaxSelectOptionsobject对ajax的select参数进行全局设置，设置editoptions跟searchoptions 参数的select属性值空值是altclassString用于表格行交替变色的class属性。你可以定义自己的class来替代默认值。只有当altRows属性设置为true时，该属性才起作用ui-priority-secondary是，但需要重新加载altRowsboolean设置表格是否允许行交替变色值false是，需重新加载autoencodeboolean当为 ture 时对url进行编码false是autowidthboolean如果为ture时，则当表格在首次被创建时会根据父元素比例重新调整表格宽度。如果父元素宽度改变，为了使表格宽度能够自动调整则需要实现函数：setGridWidthfalse否captionString定义表格名称空值否，但是可以用api修改cellLayoutinteger定义了单元格padding + border 宽度。通常不必修改此值。初始值为5，paddingLef?2+paddingRight?2+borderLeft?1=55否cellEditboolean启用或者禁用单元格编辑功能false是cellsubmitString定义了单元格内容保存位置：“remote”，“clientArray”‘remote'是cellurlString单元格提交的url空值是colModelarray对显示列属性的设置，是一个数组对象。常用到的属性：

name

列显示的名称；

index

传到服务器端用来排序用的列名称；

width

列宽度；

align

对齐方式；

sortable

是否可以排序空值否colNamesarray[]放置列名称的数组，必须与colModel大小相同空数组否datastrStringxmlstring或者jsonstring空值是datatypestring从服务器端返回的数据类型，（表格期望接收的数据类型）。可选类型：xml，xmlstring，json，local，functionxml是deselectAfterSortboolean只有当datatype为local时起作用。当排序时不选择当前行true是directionstring表格中文字的显示方向，从左向右（ltr）或者从右向左（rtr）。ltr否editurlstring定义对form编辑时的url空值是emptyrecordsstring当返回的数据行数为0时显示的信息。只有当属性 viewrecords 设置为ture时起作用在语言包中是ExpandColClickboolean当为true时，点击展开行的文本时，treeGrid就能展开或者收缩，不仅仅是点击图片true否ExpandColumnstring指定那列来展开tree grid，默认为第一列，只有在treeGrid为true时起作用空值否footerrowboolean当为true时，会在翻页栏之上增加一行false否forceFitboolean当为ture时，调整列宽度不会改变表格的宽度。当shrinkToFit 为false时，此属性会被忽略false否gridstatestring定义当前表格的状态：'visible' or 'hidden'visible否gridviewboolean构造一行数据后添加到grid中，如果设为true则是将整个表格的数据都构造完成后再添加到grid中，但treeGrid,subGrid,or afterInsertRow 不能用false是heightmixed表格高度，可以是数字，像素值或者百分比150否hiddengridboolean当为ture时，表格不会被显示，只显示表格的标题。只有当点击显示表格的那个按钮时才会去初始化表格数据。只有当caption 属性不为空而且hidegrid为ture时才起作用false否hidegridboolean启用或者禁用控制表格显示、隐藏的按钮，只有当caption 属性不为空时起效true否hoverrowsboolean当为false时mouse hovering会被禁用false是jsonReaderarray描述json期望数据格式的数组。否lastpageinteger只读属性，定义了总页数0否lastsortinteger只读属性，定义了最后排序列的索引，从0开始0否loadonceboolean如果为ture则数据只从服务器端抓取一次，之后所有操作都是在客户端执行，翻页功能会被禁用false否loadtextstring当请求或者排序时所显示的文字内容Loading....否loaduistring当执行ajax请求时要干什么。

disable

禁用ajax执行提示；

enable

默认，当执行ajax请求时的提示；

block

启用Loading提示，但是阻止其他操作enable是mtypestring请求的类型：(“POST” or “GET”)GET是multikeystring只有在multiselect设置为ture时起作用，定义使用那个key来做多选。

shiftKey

，

altKey

，

ctrlKey

空值是multiBoxonlyboolean只有当multiselect = true.起作用，当multiBoxonly 为ture时只有选择checkBox才会起作用，false是multiselectboolean定义是否可以多选false否multiselectWidthinteger当multiselect为true时设置multiselect列宽度20否pageinteger设置初始的页码1是pagermixed指定分页栏对象，必须为一个有效的html元素。可以是'pager','#pager',jQuery('#pager').推荐用'#pager'空值否pagerposstring指定分页栏的位置center否pgbuttonsboolean是否显示翻页按钮true否pginputboolean是否显示@R_121_404@面的输入框true否pgtextstring当前页信息语言包中设置是prmNamesarrayDefault valuesprmNames: {page:“page”,rows:“rows”,sort: “sidx”,order: “sord”,search:“_search”,nd:“nd”,npage:null} 当参数为null时不会被发到服务器端none是postDataarray此数组内容直接赋值到url上，参数类型：{name1:value1…}空array是reccountinteger只读属性，定义了grid中确切的行数。通常情况下与records属性相同，但有一种情况例外，假如rowNum=15，但是从服务器端返回的记录数是20，那么records值是20，但reccount值仍然为15，而且表格中也只显示15条记录。0否recordposstring定义了记录信息的位置： left,center,rightright否recordsinteger只读属性，定义了返回的记录数none否recordtextstring显示记录数信息。{0} 为记录数开始，{1}为记录数结束。 viewrecords为ture时才能起效，且总记录数大于0时才会显示此信息语言包是resizeclassstring定义一个class到一个列上用来显示列宽度调整时的效果空值否rowListarray[]一个数组用来调整表格显示的记录数，此参数值会替代rowNum参数值传给服务器端。如果为空则不显示，设置格式：[10,20,30]。[]否rownumbersboolean如果为ture则会在表格左边新增一列，显示行顺序号，从1开始递增。此列名为'rn'.false否rowNuminteger设置表格中显示的记录数，参数会被自动传到后台。如果此参数设为10，但是从服务器端返回15条记录，那么在表格中只会显示10条记录。如果设为-1则禁用此检查20是rownumWidthinteger如果rownumbers为true，则可以设置column的宽度25否savedRowarray只读属性，只用在编辑模式下保存数据空值否scrollboolean or integer创建一个动态滚动的表格，当为true时，翻页栏被禁用，使用垂直滚动条加载数据，且在首次访问服务器端时将加载所有数据到客户端。当此参数为数字时，表格只控制可见的几行，所有数据都在这几行中加载false否scrollOffsetinteger设置垂直滚动条宽度18否scrollrowsboolean当为true时让所选择的行可见false是selarrrowarray-[]只读属性，用来存放当前选择的行empty array []否selrowstring只读属性，最后选择行的idnull否shrinkToFitboolean此属性用来说明当初始化列宽度时候的计算类型，如果为ture，则按比例初始化列宽度。如果为false，则列宽度使用colModel指定的宽度true否sortableboolean是否可排序false否sortnamestring排序列的名称，此参数会被传到后台空字符串是sortorderstring排序顺序，升序或者降序（asc or desc）asc是subGridboolean是否使用suggridfalse否subGridModelarray-[]subgrid模型empty array否subGridTypemixed如果为空则使用表格的dataTypenull是subGridUrlstring加载subgrid数据的url，jqGrid会把每行的id值加到url中空值是subGridWidthintegersubgrid列的宽度20否toolbararray表格的工具栏。数组中有两个值，第一个为是否启用，第二个指定工具栏位置（相对于body layer），如：[true,”both”] 。工具栏位置可选值：“top”,”bottom”,“both”. 如果工具栏在上面，则工具栏id为“t_”+表格id；如果在下面则为 “tb_”+表格id；如果只有一个工具栏则为 “t_”+表格id[false,'']否totaltimeinteger只读属性，计算加载数据的时间。目前支持xml跟json数据0否treedatatypemixed数据类型，通常情况下与datatype相同，不会变null否treeGridboolean启用或者禁用treegrid模式false否treeGridModelstringtreeGrid所使用的方法nested否treeIconsarray树的图标，默认值：{plus:'ui-icon-triangle-1-e',minus:'ui-icon-triangle-1-s',leaf:'ui-icon-radio-off'}否treeReaderarray扩展表格的colModel且加在colModel定义的后面否tree_root_levelnumericroot元素的级别，0否urlstringurlnull是userDataarray从request中取得的一些用户信息empty array否userDataOnFooterboolean当为true时把userData放到底部，用法：如果userData的值与colModel的值相同，那么此列就显示正确的值，如果不等那么此列就为空false是viewrecordsboolean是否要显示总记录数false否viewsortcolsarray定义排序列的外观跟行为。数据格式：[false,'vertical',true].第一个参数是说，是否都要显示排序列的图标，false就是只显示当前排序列的图标；第二个参数是指图标如何显示，vertical：排序图标垂直放置，horizontal：排序图标水平放置；第三个参数指单击功能，true：单击列可排序，false：单击图标排序。说明：如果第三个参数为false则第一个参数必须为ture否则不能排序否widthnumber如果设置则按此设置为主，如果没有设置则按colModel中定义的宽度计算none否xmlReaderarray对xml数据结构的描述否

url获取数据的地址datatype从服务器端返回的数据类型，默认xml。可选类型：xml，local，json，jsonnp，script，xmlstring，jsonstring，clientsidemtypeajax提交方式。POST或者GET，默认GETcolNames列显示名称，是一个数组对象。colModel对显示列属性的设置，是一个数组对象。常用到的属性：

name

列显示的名称；

index

传到服务器端用来排序用的列名称；

width

列宽度；

align

对齐方式；

sortable

是否可以排序pager定义翻页用的导航栏，必须是有效的html元素。翻页工具栏可以放置在html页面任意位置rowNum在grid上显示记录条数，这个参数是要被传递到后台rowList一个下拉选择框，用来改变显示记录数，当选择时会覆盖rowNum参数传递到后台sortname默认的排序列。可以是列名称或者是一个数字，这个参数会被提交到后台viewrecords定义是否要显示总记录数caption表格名称

2、事件

rowid为插入的行ID rowdata是被插入行的数据数组。格式为name:value对，name在colModel定义 rowelem是应答元素。xml为xml行，json为所有行数据。注意：若gridview 为true，此事件不会发生用户点击行，选中该行前。 rowid为行的ID，e为事件对象该事件将返回布尔值true（行被选中）或false（行未被选中）。分页等无关。修改对象属性（如headers）。 xhr 为XMLHttpRequest对象。xhr为XMLHttpRequest对象； Satus为错误类型描述；error为错误对象。rowid为行ID；iCol为列索引； cellcontent为单元格中内容； e点击事件对象。rowid为行ID；iRow为行索引（勿与rowid混淆）； iCol为列索引； e为事件对象。显示或隐藏表格后发生（hidegrid为true） gridstate为表格状态，有visible和hidden两个值用户输入一个与当前页页码不同的新页码并回车时。rowid为行ID；iRow为行索引（勿与rowid混淆） iCol为列索引； e为事件对象标题的复选框时发生（multiselect为true） aRowids选定行ID的数组（哪些行的复选框与头复选框相同） status头复选框的选定的布尔值，true为选中，false为rowid为行ID； status 为选择状态。当multiselect为true时使用，当行被选中时返回true；为选中时返回false。index为colModel 中定义的索引名iCol为列的索引号 sortorder为新的排序方式，asc或descevent为事件对象；index为在colModel 中定义的列索引。newwidth为新的列宽度；index为在colModel 中定义的列索引。自定义的数据（如JSON字符串、XML字符串）要发给服务器时，可使用该事件。

  </td&gt;
</tr&gt;

3、方法

方法用法：假如我们从web服务器获得的数据（jsonresponse），则 var mygrid = jQuery(”#”+grid_id)[0]; var myjsongrid = eval(”(”+jsonresponse.responseText+”)”); mygrid.addJSONData(myjsongrid); myjsongrid = null; jsonresponse =null; 将填充网格。当然，myjsongrid中的数据在传递到addJSONData之前可以被操作。rowid为新行的ID，data（数组）为新行数据，position为新行插入的位置（first为表头，last为表尾，srcrowid指定偏移位置）。Data数组的格式为：{name1:value1,name2: value2…} ，name为colModel指定的名称。用法：假如我们从web服务器获得数据 (xmlresponse)，则 var mygrid = jQuery(”#”+grid_id)[0]; mygrid.addXmlData(xmlresponse.responseXML); 将填充网格。当然，xmlresponse中的数据在传递到addXmlData之前可以被操作。删除id = rowid的行。但不会删除服务器上的数据。方法获得或设置网格底部数据。 action– 可设置为get（缺省）或set。 Get从底部返回name:value对象（name为colModel中的名称）。此时其他两个参数无效。 Set将data数组（对象）设置到底部。Data为colName中的名称和值对。 format– 缺省为true，表示设置时使用formatter (如果colModel中已定义)。false表示不使用formatter内容。 iCol可以是列的索引或colName中定义的名称。在编辑行或列时不能使用该方法，此时返回的不是当前值，而是原始值。名称。returntype 确定返回数组的类型，为false(缺省)时，数组只包含值。为true时为对象数组，格式为{id:rowid,value:cellvalue}，id为行的id， cellvalue为单元格的值。如 [{id:1,value:1},{id:2,value:2}…] mathoperation为可选参数，可以是sum、avg和count。若此参数进行了有效设置，则返回计算后的值，若无效，则返回空数组。显示数据的ID数组。无数据时返回空数组。名称，若为设置则options被返回。名称，value为该行的值。未找到返回空数组。在行或列编辑时此方法不可用，此时返回的不是当前值，而是原始值。若rowid为设置，则返回网格中所有数据数组。名称。表格的宽度不会改变。显示顺序。permutation指定调整后的顺序，如 [1,2] 表示第一列在第二位显示。若updateCells 设置为true，列数据将重新排序。若keepHeader 设置为true，header单元格将重新排序。文字。若表头为隐藏，将显示。修改单元格的值、类或样式。其中： rowid为行ID；colname为列名（可以是从0开始的列的索引值）； data设置的内容，若为空，class若为字符串，将使用addClass为列加入一个类，若为数组，将直接加入CSS中；properties设置单元格属性。方法可以覆盖事件。名称（name:value对）为选项数组中的名称。标题文字、属性和类： colname为列名，可以是从0开始的列索引； data为标题文字，为空则不修改； class若为字符串，则为类名，若为数组，则直接写入CSS； properties为标题文字的属性。名称，value为新值。cssprop若为字符串，将使用addClass为行添加类；若为数组对象，则直接加入CSS中。将data设置为false的情况下，可设置属性和类名显示colname 指定的列。若colname为字符串，只显示指定的列，若colname为数组 [“name1”,”name2”] 则显示name1和name2列， name必须是colModel中的名称。宽度不变。方法适用于一个已建立的网格。注意不会改变表头，也就是说改变colModel将没有作用。你可用gridUnload，使用新colModel来重新加载。用法： var mygrid=jQuery(”#grid_id”)[0]; mygrid.updateColumns();