MvcJqGrid 技术文档

本文档旨在帮助用户安装、使用 MvcJqGrid，并详细说明其 API 使用方式。

1. 安装指南

1.1. 环境要求

要开始使用 MvcJqGrid，您需要以下环境：

• jQuery
• jqGrid v3.65 或更高版本
• MvcJqGrid Helper

1.2. 使用 NuGet 安装

通过 NuGet 包管理器安装 MvcJqGrid：

Install-Package MvcJqGrid

1.3. 手动安装 jqGrid

如果使用 Download Builder 创建自定义 jqGrid 包，确保选择以下模块：Grid base、Formatter、Custom、Common function 和 Form Editing。如果需要启用 treegrid，还包括 Tree Grid 模块。安装 jqGrid 的指南请参考这里。

2. 使用说明

MvcJqGrid 是一个用于 ASP.NET MVC 的 HTML 辅助工具，它可以简化在您的网站或 Web 应用程序中实现 jqGrid 的过程。辅助工具提供了一个流畅的接口，使得视图代码简洁易读。

2.1. 引入命名空间

在视图页的顶部添加以下命名空间引用：

• Razor 视图引擎：

@using MvcJqGrid

• WebForms 视图引擎：

<%@ Import Namespace="MvcJqGrid" %>

如果您的项目中的多个页面都要使用网格，可以在 web.config 文件中添加引用，以便在所有视图中启用辅助工具。

2.2. 创建基本网格

以下是如何使用 Razor 视图引擎创建基本网格的示例：

@(Html.Grid("basic")
    .SetCaption("基本网格")
    .addColumn(new Column("CustomerId")
        .setLabel("ID"))
    .addColumn(new Column("Name"))
    .addColumn(new Column("Company"))
    .addColumn(new Column("EmailAddress"))
    .addColumn(new Column("Last Modified"))
    .addColumn(new Column("Telephone"))
    .setUrl("/Home/GridData/")
    .setAutoWidth(true)
    .setRowNum(10)
    .setRowList(new int[]{10, 15, 20, 50})
    .setViewRecords(true)
    .setPager("pager"))

对于 WebForms 视图引擎，代码如下：

<%= Html.Grid("basic")
    .SetCaption("基本网格")
    .addColumn(new Column("CustomerId")
        .setLabel("ID"))
    .addColumn(new Column("Name"))
    .addColumn(new Column("Company"))
    .addColumn(new Column("EmailAddress"))
    .addColumn(new Column("Last Modified"))
    .addColumn(new Column("Telephone"))
    .setUrl("/Home/GridData/")
    .setAutoWidth(true)
    .setRowNum(10)
    .setRowList(new int[]{10, 15, 20, 50})
    .setViewRecords(true)
    .setPager("pager") %>

在客户端渲染网格后，网格会发出 AJAX 回调请求数据。SetUrl 方法指向控制器上的一个动作，该动作应返回包含请求数据的 JSON 或 XML 响应（响应类型使用 SetDataType 属性设置，默认为 JSON）。

3. 项目 API 使用文档

MvcJqGrid 提供了多种方法来配置网格，以下是一些常用的 API 方法：

• SetCaption(string caption)：设置网格标题。
• AddColumn(Column column)：添加一个列。
• SetUrl(string url)：设置 AJAX 数据请求的 URL。
• SetAutoWidth(bool autoWidth)：设置网格是否自动调整宽度。
• SetRowNum(int rowNum)：设置每页显示的行数。
• SetRowList(int[] rowList)：设置可供用户选择的每页行数列表。
• SetViewRecords(bool viewRecords)：设置是否显示总记录数。
• SetPager(string pager)：设置分页器 ID。

4. 项目安装方式

MvcJqGrid 可以通过 NuGet 包管理器安装，也可以手动下载源代码并集成到您的项目中。安装后，确保在视图中正确引用命名空间，并根据需要配置网格。如需更多帮助，请参考提供的示例应用程序和文档。