WPF Menu с привязкой данных: меню из коллекции, команды и вложенные пункты

РазделWPFУровеньСредний Чтение7 минОпубликовано ТегиWPFMenuXAMLMVVM

Меню, собранное вручную в XAML, неудобно, когда пункты зависят от прав пользователя или хранятся в базе. Покажем, как построить WPF Menu из коллекции объектов и связать пункты с командами.

Главное. WPF Menu строится из данных так же, как TreeView: HierarchicalDataTemplate отвечает за заголовок и детей, а команды, клавиши и разделители задаются через ItemContainerStyle.

Когда меню нужно строить из данных

Статическое меню в XAML хорошо, пока его состав не меняется. Но в учётных системах часто бывает иначе: пункты зависят от роли пользователя, часть модулей подключается плагинами, а список недавно открытых документов вообще живёт отдельно. Поддерживать такое меню ручным созданием MenuItem в коде неудобно, и логика быстро расползается по окну.

Menu в WPF наследуется от ItemsControl, как ListBox или TreeView. Значит, ему можно отдать коллекцию через ItemsSource и описать внешний вид пунктов шаблоном. Для вложенных подменю используется тот же HierarchicalDataTemplate, что и для деревьев.

Модель пункта меню

Начнём с простого класса. У пункта есть заголовок, необязательная клавиша-подсказка, команда и коллекция дочерних пунктов. Коллекция типа ObservableCollection позволяет добавлять пункты на лету, например для списка недавних файлов, и меню обновится само.

Флаг IsSeparator нужен, чтобы описывать разделители теми же объектами. Это проще, чем смешивать в коллекции разные типы.

MenuItemModel.vbVB.NET
Imports System.Collections.ObjectModel

Public Class MenuItemModel
    Public Property Header As String
    Public Property Gesture As String          ' подсказка, например "Ctrl+S"
    Public Property Command As ICommand
    Public Property CommandParameter As Object
    Public Property IsSeparator As Boolean
    Public Property Children As New ObservableCollection(Of MenuItemModel)

    Public Shared Function Separator() As MenuItemModel
        Return New MenuItemModel With {.IsSeparator = True}
    End Function
End Class

Шаблон и стиль контейнера

Здесь кроется главная ловушка. Если просто положить в HierarchicalDataTemplate кнопку или TextBlock с командой, клик сработает только по тексту, а клавиатурная навигация и подсветка будут вести себя странно. Шаблон отвечает лишь за содержимое заголовка, а сам MenuItem создаётся контейнером автоматически.

Поэтому команду, подсказку клавиши и прочие свойства пункта нужно привязывать через ItemContainerStyle с целевым типом MenuItem. Шаблон при этом остаётся минимальным: только текст заголовка и источник детей.

MainWindow.xamlXML
<Menu ItemsSource="{Binding MainMenu}">
  <Menu.ItemTemplate>
    <!-- шаблон: только заголовок и дети -->
    <HierarchicalDataTemplate ItemsSource="{Binding Children}">
      <TextBlock Text="{Binding Header}" />
    </HierarchicalDataTemplate>
  </Menu.ItemTemplate>

  <Menu.ItemContainerStyle>
    <!-- стиль наследуется вложенными уровнями -->
    <Style TargetType="MenuItem">
      <Setter Property="Command" Value="{Binding Command}" />
      <Setter Property="CommandParameter" Value="{Binding CommandParameter}" />
      <Setter Property="InputGestureText" Value="{Binding Gesture}" />
    </Style>
  </Menu.ItemContainerStyle>
</Menu>
ItemContainerStyle, заданный у Menu, автоматически применяется ко всем уровням вложенности: MenuItem передаёт его своим детям. Дублировать стиль в шаблоне не нужно.

Собираем меню во ViewModel

Меню описывается в коде как дерево объектов. Команды удобно делать через простой класс RelayCommand, который принимает делегат. Пункты, недоступные пользователю, можно не добавлять вовсе или вернуть False из CanExecute: тогда WPF сам сделает их серыми.

Обратите внимание на InputGestureText: он только рисует подсказку справа от пункта. Чтобы Ctrl+S действительно сохранял документ, нужен ещё KeyBinding в InputBindings окна.

MainViewModel.vbVB.NET
Public Class MainViewModel
    Public Property MainMenu As New ObservableCollection(Of MenuItemModel)

    Public Sub New(user As AppUser)
        Dim file As New MenuItemModel With {.Header = "_Файл"}
        file.Children.Add(New MenuItemModel With {
            .Header = "_Открыть...", .Gesture = "Ctrl+O",
            .Command = New RelayCommand(AddressOf OpenFile)})
        file.Children.Add(New MenuItemModel With {
            .Header = "_Сохранить", .Gesture = "Ctrl+S",
            .Command = New RelayCommand(AddressOf Save, Function() IsDirty)})
        file.Children.Add(MenuItemModel.Separator())
        file.Children.Add(New MenuItemModel With {
            .Header = "В_ыход", .Command = New RelayCommand(AddressOf AppExit)})
        MainMenu.Add(file)

        ' пункт администрирования только для админов
        If user.IsAdmin Then
            MainMenu.Add(New MenuItemModel With {.Header = "_Администрирование"})
        End If
    End Sub
End Class

Разделители

Separator в привязанном меню доставляет больше всего хлопот. Если вернуть из шаблона элемент Separator, он окажется внутри MenuItem и будет выглядеть как пустой кликабельный пункт с полоской. Правильный путь: подменить весь шаблон контейнера для пунктов-разделителей.

Делается это триггером в том же ItemContainerStyle. Когда IsSeparator равен True, MenuItem получает шаблон, состоящий из одного Separator, и перестаёт реагировать на клик и фокус.

MainWindow.xamlXML
<Style TargetType="MenuItem">
  <Setter Property="Command" Value="{Binding Command}" />
  <Setter Property="InputGestureText" Value="{Binding Gesture}" />
  <Style.Triggers>
    <DataTrigger Binding="{Binding IsSeparator}" Value="True">
      <!-- весь пункт заменяем полоской -->
      <Setter Property="Template">
        <Setter.Value>
          <ControlTemplate TargetType="MenuItem">
            <Separator />
          </ControlTemplate>
        </Setter.Value>
      </Setter>
      <Setter Property="Focusable" Value="False" />
    </DataTrigger>
  </Style.Triggers>
</Style>

Меню из базы данных и иконки

Если состав меню хранится в таблице с колонками ID, ParentID, Header и CommandKey, загрузите все строки одним запросом и соберите дерево в памяти через словарь по ID. Имя команды из базы сопоставляйте со словарём заранее зарегистрированных команд. Выполнять произвольные строки из базы как код нельзя.

Иконку пункта задают тоже через ItemContainerStyle: свойство Icon у MenuItem принимает любой элемент, например Image с привязкой Source к пути картинки в модели. Задавайте ширину и высоту 16 пикселей, иначе крупная иконка растянет пункт.

  • буква после подчёркивания в Header становится клавишей доступа (Alt+Ф), это важно для клавиатурной навигации;
  • пустое подменю без детей лучше скрывать, чем показывать стрелку в никуда;
  • для контекстного меню подход тот же: ContextMenu тоже ItemsControl.

Как это делают сегодня

В современных WPF-проектах RelayCommand и свойства берут из CommunityToolkit.Mvvm, где атрибут [RelayCommand] генерирует команду из метода, а список модулей приходит через внедрение зависимостей. В Avalonia и WinUI 3 привязка меню устроена похоже, а в .NET MAUI для десктопа меню описывают через MenuBarItem. Пункты для ролей обычно фильтруют один раз при сборке модели, а не триггерами в XAML.

Вопросы и ответы

Почему команда срабатывает только при клике по тексту?

Скорее всего, команда привязана к элементу внутри шаблона, а не к самому MenuItem. Перенесите привязку Command в ItemContainerStyle, тогда кликабельной станет вся строка пункта.

Как обновить меню без перезапуска окна?

Используйте ObservableCollection для корня и для Children. Добавление и удаление пунктов сразу отражаются в меню; для смены заголовка у модели нужен INotifyPropertyChanged.

Работает ли этот подход в ContextMenu?

Да, но у ContextMenu собственное визуальное дерево, и DataContext окна туда не наследуется. Привяжите DataContext контекстного меню через PlacementTarget.DataContext.

Читайте также