萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> ASP.NET 程式設計

ASP.NET DataPager 分頁控制項深度解析:TemplatePagerField 自訂分頁 UI 實戰

`DataPager` 是 ASP.NET WebForms 內建的分頁控制項,搭配 `ListView` 使用時功能強大。本文深入解析 `TemplatePagerField` 客製化分頁 UI、伺服端命令處理、樣式整合 (Bootstrap)、以及大量資料效能優化 (自訂分頁查詢)。

基本架構

<asp:ListView ID="lvProducts" runat="server" DataSourceID="dsProducts">
    <LayoutTemplate>
        <table class="table"><tbody id="itemPlaceholder" runat="server"></tbody></table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr><td><%# Eval("Name") %></td><td><%# Eval("Price", "{0:C}") %></td></tr>
    </ItemTemplate>
</asp:ListView>

<asp:DataPager ID="dpProducts" runat="server" PagedControlID="lvProducts" PageSize="10">
    <Fields>
        <asp:TemplatePagerField OnPagerCommand="Pager_Command">
            <PagerTemplate> ... </PagerTemplate>
        </asp:TemplatePagerField>
    </Fields>
</asp:DataPager>

TemplatePagerField 完整模板範例 (Bootstrap 5 風格)

<PagerTemplate>
    <nav aria-label="Page navigation">
        <ul class="pagination pagination-sm justify-content-center mb-0">
            <!-- 首頁 -->
            <li class="page-item <%# Container.StartRowIndex == 0 ? "disabled" : "" %>">
                <asp:LinkButton ID="lbFirst" runat="server" CommandName="First" CommandArgument="First" CssClass="page-link">««</asp:LinkButton>
            </li>
            <!-- 上一頁 -->
            <li class="page-item <%# Container.StartRowIndex == 0 ? "disabled" : "" %>">
                <asp:LinkButton ID="lbPrev" runat="server" CommandName="Previous" CssClass="page-link">«</asp:LinkButton>
            </li>
            <!-- 頁碼 (以 Container.TotalRowCount、PageSize 計算) -->
            <%-- 這裡建議改用伺服端迴圈產生頁碼,見下方程式碼後置 --%>
            <!-- 下一頁 -->
            <li class="page-item <%# (Container.StartRowIndex + Container.PageSize) >= Container.TotalRowCount ? "disabled" : "" %>">
                <asp:LinkButton ID="lbNext" runat="server" CommandName="Next" CssClass="page-link">»</asp:LinkButton>
            </li>
            <!-- 末頁 -->
            <li class="page-item <%# (Container.StartRowIndex + Container.PageSize) >= Container.TotalRowCount ? "disabled" : "" %>">
                <asp:LinkButton ID="lbLast" runat="server" CommandName="Last" CommandArgument="Last" CssClass="page-link">»»</asp:LinkButton>
            </li>
        </ul>
    </nav>
    <span class="text-muted small ms-2">
        顯示 <%# Container.StartRowIndex + 1 %> - <%# Math.Min(Container.StartRowIndex + Container.PageSize, Container.TotalRowCount) %> 筆,共 <%# Container.TotalRowCount %> 筆
    </span>
</PagerTemplate>

伺服端命令處理 (OnPagerCommand)

protected void Pager_Command(object sender, DataPagerCommandEventArgs e) {
    var pager = (DataPager)sender;
    int newStart = pager.StartRowIndex;
    int pageSize = pager.PageSize;

    switch (e.CommandName) {
        case "First": newStart = 0; break;
        case "Previous": newStart = Math.Max(0, pager.StartRowIndex - pageSize); break;
        case "Next": newStart = pager.StartRowIndex + pageSize; break;
        case "Last": newStart = (int)Math.Ceiling((double)e.TotalRowCount / pageSize) * pageSize - pageSize; break;
        case "Page": // 自訂頁碼按鈕 CommandName="Page" CommandArgument="3"
            if (int.TryParse(e.CommandArgument?.ToString(), out int targetPage))
                newStart = (targetPage - 1) * pageSize;
            break;
    }

    if (newStart != pager.StartRowIndex) {
        pager.SetPageProperties(newStart, pageSize, true); // true = 重新繫結
    }
}

動態產生頁碼按鈕 (程式碼後置)

在 `DataPager.PreRender` 事件中動態建立頁碼 `LinkButton`,支援「...」省略:

protected void dpProducts_PreRender(object sender, EventArgs e) {
    var pager = (DataPager)sender;
    var templateField = pager.Fields.OfType().FirstOrDefault();
    if (templateField == null) return;

    // 找到 PagerTemplate 實例化的容器 (通常是第一個 Control)
    var container = templateField.Controls[0]; // 視實際結構調整
    var phPages = container.FindControl("phPageNumbers") as PlaceHolder; // 在 PagerTemplate 放 
    if (phPages == null) return;

    phPages.Controls.Clear();
    int totalPages = (int)Math.Ceiling((double)pager.TotalRowCount / pager.PageSize);
    int currentPage = pager.StartRowIndex / pager.PageSize + 1;

    for (int i = 1; i <= totalPages; i++) {
        if (i == 1 || i == totalPages || Math.Abs(i - currentPage) <= 2) {
            var btn = new LinkButton {
                Text = i.ToString(),
                CommandName = "Page",
                CommandArgument = i.ToString(),
                CssClass = "page-link" + (i == currentPage ? " active" : ""),
                CausesValidation = false
            };
            var li = new HtmlGenericControl("li") { Attributes = { ["class"] = "page-item" + (i == currentPage ? " active" : "") } };
            li.Controls.Add(btn);
            phPages.Controls.Add(li);
        } else if (i == currentPage - 3 || i == currentPage + 3) {
            phPages.Controls.Add(new LiteralControl("
  • ...
  • ")); } } }

    大量資料效能優化:自訂分頁查詢

    預設 `DataPager` 配合 `SqlDataSource` 會先查出所有資料再在記憶體分頁。**百萬筆資料會 OOM**。解法:改用 `ObjectDataSource` + 自訂分頁方法:

    // DAL
    public class ProductRepository {
        public (List, int) GetPaged(int startRow, int maxRows, string sort) {
            using (var conn = new SqlConnection(ConnStr)) {
                // SQL Server 2012+ OFFSET/FETCH
                string sql = @"SELECT * FROM Products ORDER BY " + SanitizeSort(sort) + 
                             " OFFSET @Offset ROWS FETCH NEXT @PageSize ROWS ONLY; 
                              SELECT COUNT(*) FROM Products;";
                using (var cmd = new SqlCommand(sql, conn)) {
                    cmd.Parameters.AddWithValue("@Offset", startRow);
                    cmd.Parameters.AddWithValue("@PageSize", maxRows);
                    conn.Open();
                    using (var reader = cmd.ExecuteReader()) {
                        var list = new List();
                        while (reader.Read()) list.Add(MapProduct(reader));
                        reader.NextResult();
                        reader.Read();
                        int total = reader.GetInt32(0);
                        return (list, total);
                    }
                }
            }
        }
    }
    
    // ObjectDataSource 設定
    

    常見問題

    • `SetPageProperties` 第三參數 `true` 會觸發 `DataBind`,若在 `Page_Load` 呼叫需注意生命週期。
    • `Container` 在 `PagerTemplate` 中提供 `StartRowIndex`、`PageSize`、`TotalRowCount`、`MaximumRows` 等屬性。
    • 若 `DataPager` 放在 `UpdatePanel` 內,需設定 `ChildrenAsTriggers="true"` 或手動 `Update()`。

    善用 `TemplatePagerField` 客製化 UI、搭配資料庫層級分頁查詢,即能打造高效能、美觀且可維護的分頁體驗。

    copyright © 萬盛學電腦網 all rights reserved