
Алфавитный пейджер для GridView: показываем записи по первой букве
Справочник клиентов или сотрудников удобнее листать не по номерам страниц, а по буквам, как телефонную книгу. Собираем такой пейджер над GridView без сторонних библиотек.
Когда номера страниц неудобны
Номер страницы ничего не говорит пользователю. Чтобы найти клиента «Смирнов» в списке из двух тысяч записей, ему придётся угадывать: это страница 70 или 85? Алфавитная навигация решает задачу естественнее: ряд букв над таблицей, клик по «С» показывает всех, чьё имя начинается на эту букву. Тот же принцип работает в бумажных справочниках и в адресной книге телефона.
Технически это не пагинация, а фильтр по первой букве. Поэтому его легко совместить с обычным постраничным выводом: внутри буквы «С» может оказаться и сто записей, и тогда снизу появится стандартный пейджер.
Ряд букв: только те, что есть в данных
Можно вывести весь алфавит жёстко, но тогда пользователь будет кликать по буквам, за которыми ничего нет, и видеть пустую таблицу. Лучше спросить у базы, с каких букв реально начинаются записи. Запрос с DISTINCT и UPPER(LEFT(...)) возвращает короткий список, который стоит закешировать.
Буквы выводим через Repeater с LinkButton. Это проще и гибче, чем пытаться встроить их в стандартный PagerTemplate грида: пейджер GridView виден только при включённой пагинации и наличии нескольких страниц, а алфавит нужен всегда. Первой кнопкой ставим «Все», чтобы снять фильтр.
<nav class="alpha" aria-label="Фильтр по первой букве">
<asp:LinkButton ID="btnAll" runat="server" Text="Все"
CommandArgument="" OnCommand="Letter_Command" />
<asp:Repeater ID="rptLetters" runat="server">
<ItemTemplate>
<asp:LinkButton runat="server" Text='<%# Container.DataItem %>'
CommandArgument='<%# Container.DataItem %>'
OnCommand="Letter_Command"
CssClass='<%# If(CStr(Container.DataItem) = CurrentLetter, "is-active", "") %>' />
</ItemTemplate>
</asp:Repeater>
</nav>
<asp:GridView ID="GridView1" runat="server" CssClass="grid"
AllowPaging="true" PageSize="25" DataKeyNames="CustomerID"
EmptyDataText="Нет записей на эту букву" />Состояние и обработчик клика
Выбранную букву храним во ViewState, чтобы она переживала постбэки при листании страниц и сортировке. Все кнопки, включая «Все», ведут в один обработчик Letter_Command, где буква берётся из CommandArgument. Пустая строка означает отсутствие фильтра.
После смены буквы обязательно сбрасываем PageIndex в ноль. Иначе, если пользователь был на пятой странице буквы «А», при переходе на «Я» с двумя страницами он увидит пустоту. Ряд букв тоже перепривязываем, чтобы обновилась подсветка активной кнопки.
Protected Property CurrentLetter As String
Get
Return CStr(If(ViewState("Letter"), ""))
End Get
Set(value As String)
ViewState("Letter") = value
End Set
End Property
Protected Sub Page_Load(sender As Object, e As EventArgs) Handles Me.Load
If Not IsPostBack Then
BindLetters()
BindGrid()
End If
End Sub
Protected Sub Letter_Command(sender As Object, e As CommandEventArgs)
CurrentLetter = CStr(e.CommandArgument)
GridView1.PageIndex = 0 ' новая буква: с первой страницы
BindLetters() ' обновить подсветку
BindGrid()
End Sub
Protected Sub GridView1_PageIndexChanging(sender As Object,
e As GridViewPageEventArgs) Handles GridView1.PageIndexChanging
GridView1.PageIndex = e.NewPageIndex
BindGrid()
End SubЗапрос с фильтром: параметр, а не склейка
Соблазнительно собрать запрос строкой: "WHERE CompanyName LIKE '" & letter & "%'". Так делать нельзя даже для одной буквы: CommandArgument приходит из формы, его можно подменить, и это классическая SQL-инъекция. Передаём букву параметром и склеиваем шаблон уже на стороне SQL.
Один запрос обслуживает оба режима: когда параметр пустой, условие @letter = '' истинно и фильтр не действует. Для небольших справочников этого достаточно; если записей сотни тысяч, проверьте план выполнения: LIKE с шаблоном по началу строки использует индекс по колонке, а вот обёртка UPPER() вокруг колонки его отключит.
Private Sub BindGrid()
Const sql = "SELECT CustomerID, CompanyName, City, Country FROM Customers " &
"WHERE @letter = '' OR CompanyName LIKE @letter + '%' " &
"ORDER BY CompanyName"
Dim table As New DataTable()
Using cn As New SqlConnection(ConnString),
da As New SqlDataAdapter(sql, cn)
da.SelectCommand.Parameters.Add("@letter", SqlDbType.NVarChar, 1).Value =
CurrentLetter
da.Fill(table)
End Using
GridView1.DataSource = table
GridView1.DataBind()
End Sub
Private Sub BindLetters()
Const sql = "SELECT DISTINCT UPPER(LEFT(CompanyName, 1)) AS L " &
"FROM Customers ORDER BY L"
Dim letters As New DataTable()
Using cn As New SqlConnection(ConnString), da As New SqlDataAdapter(sql, cn)
da.Fill(letters)
End Using
rptLetters.DataSource = letters.AsEnumerable().Select(Function(r) r.Field(Of String)("L"))
rptLetters.DataBind()
End SubКириллица, цифры и регистр
В русскоязычных справочниках встречаются подводные камни, о которых англоязычные примеры молчат. Чувствительность к регистру и порядок букв определяет collation колонки. С Cyrillic_General_CI_AS поиск LIKE 'с%' найдёт и «Смирнов», и «смирнов», а буквы выстроятся в правильном русском порядке. Но буква «Ё» в некоторых collation сортируется отдельно, после «Я», и это нужно проверить на своих данных.
Названия, начинающиеся с цифр, кавычек или латиницы, лучше собрать в отдельную кнопку «0-9» или «Другие», а не плодить десяток одиночных символов. Её фильтр пишется условием NOT LIKE '[А-ЯЁA-Z]%' (диапазоны в квадратных скобках LIKE тоже зависят от collation, проверьте на тестовой базе).
Оформление и доступность
Ряд букв обычно выводят как горизонтальную ленту, которая на узком экране переносится на несколько строк. Активную букву выделяют цветом фона и жирным начертанием, а для экранных дикторов добавляют aria-current="true". Обёртка nav с понятным aria-label подсказывает, что это навигация, а не случайный набор ссылок.
Размер кнопки должен быть не меньше 32 на 32 пикселя, иначе на телефоне по букве не попасть. И не забывайте видимый фокус: кто листает справочник с клавиатуры, должен видеть, на какой букве он находится.
Как это делают сегодня
Вопросы и ответы
Почему при переходе на другую букву таблица пустая?
Скорее всего, не сброшен PageIndex: номер страницы остался от предыдущей буквы и превышает число страниц новой выборки. Обнуляйте его в обработчике клика по букве.
Можно ли встроить буквы в стандартный пейджер GridView?
Можно через PagerTemplate, но пейджер отображается только при AllowPaging и нескольких страницах. Отдельный Repeater над таблицей надёжнее и не зависит от количества записей.
Как показать количество записей у каждой буквы?
Добавьте в запрос букв COUNT(*) с GROUP BY UPPER(LEFT(CompanyName, 1)) и выведите число в подсказке title или маленьким индексом рядом с буквой.