Поделиться через

Добавление обработчика событий с помощью кода (WPF .NET)

  • Статья

Обработчик событий можно назначить элементу в Windows Presentation Foundation (WPF) с помощью разметки или программной части. Хотя обычно назначается обработчик событий в языке разметки расширяемых приложений (XAML), иногда может потребоваться назначить обработчик событий в коде программной части. Например, используйте код, когда:

  • Обработчик событий назначается элементу после загрузки страницы разметки, содержащей элемент.
  • Вы добавляете элемент и назначаете его обработчик событий после загрузки страницы разметки, которая будет содержать этот элемент.
  • Дерево элементов для приложения определяется полностью в коде.

Необходимые условия

В статье предполагается, что вы имеете базовые знания о маршрутизируемых событиях и что вы прочитали обзор маршрутизируемых событий. Чтобы следовать примерам в этой статье, это поможет вам, если вы знакомы с языком разметки расширяемых приложений (XAML) и узнаете, как писать приложения Windows Presentation Foundation (WPF).

Синтаксис назначения обработчика событий

C# поддерживает назначение обработчика событий с помощью:

  • Оператор +=, который также используется в модели обработки событий среды CLR.
  • Метод UIElement.AddHandler.

VB поддерживает назначение обработчика событий с помощью:

  • Оператор AddHandler с оператором AddressOf, который также используется в модели обработки событий CLR.
  • Ключевое слово обрабатывает в определении обработчика событий. Для получения дополнительной информации см. Обработка событий Visual Basic и WPF .
  • Метод UIElement.AddHandler вместе с оператором AddressOf для ссылки на обработчик событий.

Пример

В следующем примере xaml используется для определения Button с именем ButtonCreatedByXaml и назначения метода ButtonCreatedByXaml_Click в качестве обработчика событий Click. Click — это встроенное маршрутизируемое событие для кнопок, производных от ButtonBase.

<StackPanel Name="StackPanel1">
    <Button
        Name="ButtonCreatedByXaml" 
        Click="ButtonCreatedByXaml_Click"
        Content="Create a new button with an event handler"
        Background="LightGray">
    </Button>
</StackPanel>

В этом примере используется код позади для реализации обработчиков ButtonCreatedByXaml_Click и ButtonCreatedByCode_Click, а также для назначения обработчика ButtonCreatedByCode_Click элементам ButtonCreatedByCode и StackPanel1. Методы обработчика событий можно реализовать только в коде программной части.

// The click event handler for the existing button 'ButtonCreatedByXaml'.
private void ButtonCreatedByXaml_Click(object sender, RoutedEventArgs e)
{
    // Create a new button.
    Button ButtonCreatedByCode = new();

    // Specify button properties.
    ButtonCreatedByCode.Name = "ButtonCreatedByCode";
    ButtonCreatedByCode.Content = "New button and event handler created in code";
    ButtonCreatedByCode.Background = Brushes.Yellow;

    // Add the new button to the StackPanel.
    StackPanel1.Children.Add(ButtonCreatedByCode);

    // Assign an event handler to the new button using the '+=' operator.
    ButtonCreatedByCode.Click += new RoutedEventHandler(ButtonCreatedByCode_Click);

    // Assign an event handler to the new button using the AddHandler method.
    // AddHandler(ButtonBase.ClickEvent, new RoutedEventHandler(ButtonCreatedByCode_Click);

    // Assign an event handler to the StackPanel using the AddHandler method.
    StackPanel1.AddHandler(ButtonBase.ClickEvent, new RoutedEventHandler(ButtonCreatedByCode_Click));
}

// The Click event handler for the new button 'ButtonCreatedByCode'.
private void ButtonCreatedByCode_Click(object sender, RoutedEventArgs e)
{
    string sourceName = ((FrameworkElement)e.Source).Name;
    string senderName = ((FrameworkElement)sender).Name;

    Debug.WriteLine($"Routed event handler attached to {senderName}, " +
        $"triggered by the Click routed event raised by {sourceName}.");
}

' The click event handler for the existing button 'ButtonCreatedByXaml'.
Private Sub ButtonCreatedByXaml_Click(sender As Object, e As RoutedEventArgs)

    ' Create a new button and specify button properties.
    Dim ButtonCreatedByCode As New Button With {
        .Name = "ButtonCreatedByCode",
        .Content = "New button and event handler created in code",
        .Background = Brushes.Yellow
    }

    ' Add the new button to the StackPanel.
    StackPanel1.Children.Add(ButtonCreatedByCode)

    ' Assign an event handler to the new button using the AddHandler statement.
    AddHandler ButtonCreatedByCode.Click, AddressOf ButtonCreatedByCode_Click

    ' Assign an event handler to the new button using the AddHandler method.
    ' ButtonCreatedByCode.AddHandler(ButtonBase.ClickEvent, New RoutedEventHandler(AddressOf ButtonCreatedByCode_Click))

    ' Assign an event handler to the StackPanel using the AddHandler method.
    StackPanel1.AddHandler(ButtonBase.ClickEvent, New RoutedEventHandler(AddressOf ButtonCreatedByCode_Click))

End Sub

' The Click event handler for the new button 'ButtonCreatedByCode'.
Private Sub ButtonCreatedByCode_Click(sender As Object, e As RoutedEventArgs)

    Dim sourceName As String = CType(e.Source, FrameworkElement).Name
    Dim senderName As String = CType(sender, FrameworkElement).Name

    Debug.WriteLine($"Routed event handler attached to {senderName}, " +
        $"triggered by the Click routed event raised by {sourceName}.")

End Sub

При щелчке ButtonCreatedByXaml и запуске обработчика событий ButtonCreatedByXaml_Click программным способом:

  1. Добавляет новую кнопку с именем ButtonCreatedByCode в уже созданное дерево элементов XAML.
  2. Задает свойства новой кнопки, например имя, содержимое и цвет фона.
  3. Назначает объекту ButtonCreatedByCodeобработчик событий ButtonCreatedByCode_Click.
  4. Назначает тот же обработчик событий ButtonCreatedByCode_Click для StackPanel1.

Когда щелкают по ButtonCreatedByCode:

  1. Событие маршрутизации Click вызывается на ButtonCreatedByCode.
  2. Запускается обработчик событий ButtonCreatedByCode_Click, назначенный ButtonCreatedByCode.
  3. Click маршрутизируемое событие проходит по дереву элементов до StackPanel1.
  4. Запускается обработчик событий ButtonCreatedByCode_Click, назначенный StackPanel1.
  5. Событие Click продолжает распространяться вверх по дереву элементов, потенциально активируя другие обработчики событий Click, назначенные другим пройденным элементам.

Обработчик событий ButtonCreatedByCode_Click получает следующие сведения о событии, вызвавшее его:

  • Объект отправителя, который представляет собой элемент, которому назначен обработчик событий. sender будет ButtonCreatedByCode при первом запуске обработчика и StackPanel1 при втором запуске.
  • Объект RoutedEventArgs.Source, который является элементом, который первоначально вызвал событие. В этом примере Source всегда ButtonCreatedByCode.

Заметка

Ключевое различие между маршрутизированным событием и событием CLR заключается в том, что маршрутизированное событие проходит по дереву элементов, ища обработчики, в то время как событие CLR не проходит по дереву элементов, и обработчики могут подключаться только к исходному объекту, вызвавшему событие. В результате маршрутизируемое событие sender может быть любым пройденным элементом в дереве элементов.

Дополнительные сведения о создании и обработке маршрутизируемых событий см. в статьях Как создать пользовательское маршрутизируемое событие и Как обрабатывать маршрутизируемое событие.

См. также