From 170bc015914d3643341243b00888a58c887ca377 Mon Sep 17 00:00:00 2001 From: guardrex <1622880+guardrex@users.noreply.github.com> Date: Thu, 11 Mar 2021 08:34:47 -0600 Subject: [PATCH 1/5] Blazor Event Handling UE Pass --- .../blazor/components/event-handling.md | 283 +++++++++++++----- 1 file changed, 206 insertions(+), 77 deletions(-) diff --git a/aspnetcore/blazor/components/event-handling.md b/aspnetcore/blazor/components/event-handling.md index 451a1aa44283..36764e3564ee 100644 --- a/aspnetcore/blazor/components/event-handling.md +++ b/aspnetcore/blazor/components/event-handling.md @@ -5,67 +5,127 @@ description: Learn about Blazor's event handling features, including event argum monikerRange: '>= aspnetcore-3.1' ms.author: riande ms.custom: mvc -ms.date: 10/20/2020 +ms.date: 03/11/2021 no-loc: [appsettings.json, "ASP.NET Core Identity", cookie, Cookie, Blazor, "Blazor Server", "Blazor WebAssembly", "Identity", "Let's Encrypt", Razor, SignalR] uid: blazor/components/event-handling --- # ASP.NET Core Blazor event handling -Razor components provide event handling features. For an HTML element attribute named [`@on{EVENT}`](xref:mvc/views/razor#onevent) (for example, `@onclick`) with a delegate-typed value, a Razor component treats the attribute's value as an event handler. +Specify delegate event handlers in Razor component markup with [`@on{EVENT}={DELEGATE}`](xref:mvc/views/razor#onevent) with the following placeholder values: -The following code calls the `UpdateHeading` method when the button is selected in the UI: +* `{EVENT}` is a [Document Object Model (DOM)](https://developer.mozilla.org/docs/Web/API/Document_Object_Model/Introduction) event (for example, `@onclick`). +* `{DELEGATE}` is the delegate-typed value. -```razor - +The following code: -@code { - private void UpdateHeading(MouseEventArgs e) - { - ... - } -} -``` +* Calls the `UpdateHeading` method when the button is selected in the UI. +* Calls the `CheckChanged` method when the check box is changed in the UI. -The following code calls the `CheckChanged` method when the check box is changed in the UI: +`Pages/EventHandlerExample1.razor`: ```razor - +@page "/event-handler-example-1" + +
+ + +
+ ++ +
@code { + private string currentHeading = "Initial heading"; + private string newHeading; + private string checkedMessage = "Not changed yet"; + + private void UpdateHeading() + { + currentHeading = $"{newHeading}!!!"; + } + private void CheckChanged() { - ... + checkedMessage = $"Last changed at {DateTime.Now}"; } } ``` Event handlers can also be asynchronous and return a+ + +
@code { - private async Task UpdateHeading(MouseEventArgs e) + private string currentHeading = "Initial heading"; + private string newHeading; + + private async Task UpdateHeading() { - await ... + await Task.Delay(2000); + + currentHeading = $"{newHeading}!!!"; } } ``` ## Event argument types -For some events, event argument types are permitted. Specifying an event parameter in an event method definition is optional and only necessary if the event type is used in the method. In the following example, the `MouseEventArgs` event argument is used in the `ShowMessage` method to set message text: +For some events, event argument types are permitted. Specifying an event parameter in an event method definition is only necessary if the event type is used in the method. In the following example, the `MouseEventArgs` event argument is used in the `ReportPointerLocation` method to set message text. -```csharp -private void ShowMessage(MouseEventArgs e) +`Pages/EventHandlerExample3.razor`: + +```razor +@page "/event-handler-example-3" + +@for (var i = 0; i < 4; i++) { - messageText = $"The mouse is at coordinates: {e.ScreenX}:{e.ScreenY}"; ++ +
+} + +@mousePointerMessage
+ +@code { + private string mousePointerMessage; + + private void ReportPointerLocation(MouseEventArgs e) + { + mousePointerMessage = $"Mouse coordinates: {e.ScreenX}:{e.ScreenY}"; + } } ``` @@ -73,8 +133,8 @@ Supported+ +
+ +@code { + private string heading = "Initial heading"; +} ``` -It's often convenient to close over additional values, such as when iterating over a set of elements. The following example creates three buttons, each of which calls `UpdateHeading` passing an event argument (+ +
} @code { - private string message = "Select a button to learn its position."; + private string heading = "Select a button to learn its position"; private void UpdateHeading(MouseEventArgs e, int buttonNumber) { - message = $"You selected Button #{buttonNumber} at " + - $"mouse position: {e.ClientX} X {e.ClientY}."; + heading = $"Selected #{buttonNumber} at {e.ClientX}:{e.ClientY}"; } } ``` > [!NOTE] -> Do **not** use a loop variable directly in a lambda expression, such as `i` in the preceding `for` loop example. Otherwise, the same variable is used by all lambda expressions, which results in use of the same value in all lambdas. Always capture the variable's value in a local variable and then use it. In the preceding example, the loop variable `i` is assigned to `buttonNumber`. +> Do **not** use a loop variable directly in a lambda expression, such as `i` in the preceding `for` loop example. Otherwise, the same variable is used by all lambda expressions, which results in use of the same value in all lambdas. Always capture the variable's value in a local variable and then use it. In the preceding example: +> +> * The loop variable `i` is assigned to `buttonNumber`. +> * `buttonNumber` is used in the lambda expression. ## EventCallback -A common scenario with nested components is the desire to run a parent component's method when a child component event occurs. An `onclick` event occurring in the child component is a common use case. To expose events across components, use an+ +
-[!code-razor[](~/blazor/common/samples/5.x/BlazorWebAssemblySample/Components/ChildComponent.razor?highlight=5-7,17-18)] +@code { + [Parameter] + public string Title { get; set; } -The `ParentComponent` sets the child's@messageText
+@message
@code { - private string messageText; + private string message; private void ShowMessage(MouseEventArgs e) { - messageText = $"Blaze a new trail with Blazor! ({e.ScreenX}, {e.ScreenY})"; + message = $"Blaze a new trail with Blazor! ({e.ScreenX}:{e.ScreenY})"; } } ``` When the button is selected in the `ChildComponent`: -* The `ParentComponent`'s `ShowMessage` method is called. `messageText` is updated and displayed in the `ParentComponent`. -* A call to [`StateHasChanged`](xref:blazor/components/lifecycle#state-changes) isn't required in the callback's method (`ShowMessage`).+ +
@code { private int count = 0; @@ -238,40 +342,57 @@ Specifying the `@on{EVENT}:preventDefault` attribute without a value is equivale The value of the attribute can also be an expression. In the following example, `shouldPreventDefault` is a `bool` field set to either `true` or `false`: ```razor - + + +... + +@code { + private bool shouldPreventDefault = true; +} ``` ## Stop event propagation -Use the [`@on{EVENT}:stopPropagation`](xref:mvc/views/razor#oneventstoppropagation) directive attribute to stop event propagation. +Use the [`@on{EVENT}:stopPropagation`](xref:mvc/views/razor#oneventstoppropagation) directive attribute to stop event propagation, where the `{EVENT}` placeholder is a [Document Object Model (DOM)](https://developer.mozilla.org/docs/Web/API/Document_Object_Model/Introduction) event. -In the following example, selecting the check box prevents click events from the second child `+ @message +
+ @code { private bool stopPropagation = false; + private string message; + + private void OnSelectParentDiv() => + message = $"The parent div was selected. {DateTime.Now}"; - private void OnSelectParentDiv() => - Console.WriteLine($"The parent div was selected. {DateTime.Now}"); - private void OnSelectChildDiv() => - Console.WriteLine($"A child div was selected. {DateTime.Now}"); + private void OnSelectChildDiv() => + message = $"A child div was selected. {DateTime.Now}"; } ``` @@ -279,16 +400,24 @@ In the following example, selecting the check box prevents click events from the ## Focus an element -Call `FocusAsync` on an [element reference](xref:blazor/call-javascript-from-dotnet#capture-references-to-elements) to focus an element in code: +Call+ +
- + @code { private ElementReference exampleInput; - + private async Task ChangeFocus() { await exampleInput.FocusAsync(); From a26c2e41cd98469f04017d08972e021d90424e3e Mon Sep 17 00:00:00 2001 From: guardrex <1622880+guardrex@users.noreply.github.com> Date: Fri, 12 Mar 2021 05:28:26 -0600 Subject: [PATCH 2/5] Add custom event args for 6.0 --- .../blazor/components/event-handling.md | 154 +++++++++++++++++- 1 file changed, 153 insertions(+), 1 deletion(-) diff --git a/aspnetcore/blazor/components/event-handling.md b/aspnetcore/blazor/components/event-handling.md index 36764e3564ee..d7543cd41c19 100644 --- a/aspnetcore/blazor/components/event-handling.md +++ b/aspnetcore/blazor/components/event-handling.md @@ -99,7 +99,13 @@ In the following example, `UpdateHeading`: } ``` -## Event argument types +## Event arguments + +::: moniker range=">= aspnetcore-6.0" + +### Built-in event arguments + +::: moniker-end For some events, event argument types are permitted. Specifying an event parameter in an event method definition is only necessary if the event type is used in the method. In the following example, the `MouseEventArgs` event argument is used in the `ReportPointerLocation` method to set message text. @@ -177,6 +183,152 @@ For more information, see the following resources: * [MDN web docs: GlobalEventHandlers](https://developer.mozilla.org/docs/Web/API/GlobalEventHandlers): Includes information on which HTML elements support each DOM event. +::: moniker range=">= aspnetcore-6.0" + +### Custom event arguments + +Blazor supports custom event arguments, which enable you to pass arbitrary data to .NET event handlers with custom events. + +#### General configuration + +Custom events with custom event arguments are generally enabled with the following steps. + +1. In JavaScript, define a function for building the custom event argument object from the source event: + + ```javascript + function eventArgsCreator(event) { + return { + customProperty1: 'any value for property 1', + customProperty2: event.srcElement.value + }; + } + ``` + +1. Register the custom event with the above created handler: + + ```javascript + Blazor.registerCustomEventType('customevent', { + createEventArgs: eventArgsCreator; + ``` + + > [!NOTE] + > The call to `registerCustomEventType` is performed in a JavaScript only once per event. + +1. Define a class for the event args: + + ```csharp + public class CustomEventArgs : EventArgs{ + public string CustomProperty1 {get; set;} + public string CustomProperty2 {get; set;} + } + ``` + +1. Wire up the custom event with the event args by adding an+ @message +
+ +@code { + private string message; + + private void HandleCustomPaste(CustomPasteEventArgs eventArgs) + { + message = $"At {eventArgs.EventTimestamp.ToShortTimeString()}, " + + $"you pasted: {eventArgs.PastedData}"; + } +} +``` + +::: moniker-end + ## Lambda expressions [Lambda expressions](/dotnet/csharp/programming-guide/statements-expressions-operators/lambda-expressions) can also be used as the delegate event handler. From 579a4b1e92481852ac9ea1cf9985f15a8147515d Mon Sep 17 00:00:00 2001 From: guardrex <1622880+guardrex@users.noreply.github.com> Date: Mon, 15 Mar 2021 07:26:20 -0500 Subject: [PATCH 3/5] Updates --- .../blazor/components/event-handling.md | 61 +++++++++++-------- aspnetcore/release-notes/aspnetcore-5.0.md | 2 +- 2 files changed, 36 insertions(+), 27 deletions(-) diff --git a/aspnetcore/blazor/components/event-handling.md b/aspnetcore/blazor/components/event-handling.md index d7543cd41c19..157455fb452b 100644 --- a/aspnetcore/blazor/components/event-handling.md +++ b/aspnetcore/blazor/components/event-handling.md @@ -5,16 +5,22 @@ description: Learn about Blazor's event handling features, including event argum monikerRange: '>= aspnetcore-3.1' ms.author: riande ms.custom: mvc -ms.date: 03/11/2021 +ms.date: 03/15/2021 no-loc: [appsettings.json, "ASP.NET Core Identity", cookie, Cookie, Blazor, "Blazor Server", "Blazor WebAssembly", "Identity", "Let's Encrypt", Razor, SignalR] uid: blazor/components/event-handling --- # ASP.NET Core Blazor event handling -Specify delegate event handlers in Razor component markup with [`@on{EVENT}={DELEGATE}`](xref:mvc/views/razor#onevent) with the following placeholder values: +Specify delegate event handlers in Razor component markup with [`@on{DOM EVENT}="{DELEGATE}"`](xref:mvc/views/razor#onevent) Razor syntax: -* `{EVENT}` is a [Document Object Model (DOM)](https://developer.mozilla.org/docs/Web/API/Document_Object_Model/Introduction) event (for example, `@onclick`). -* `{DELEGATE}` is the delegate-typed value. +* The `{DOM EVENT}` placeholder is a [Document Object Model (DOM) event](https://developer.mozilla.org/docs/Web/Events) (for example, `onclick`). +* The `{DELEGATE}` placeholder is the C# delegate handler. + +Event handling characteristics include the following: + +* Asynchronous delegate event handlers that return a+ + +
+ ++ +
+ +@code { + private string currentHeading = "Initial heading"; + private string newHeading; + private string checkedMessage = "Not changed yet"; + + private void UpdateHeading() + { + currentHeading = $"{newHeading}!!!"; + } + + private void CheckChanged() + { + checkedMessage = $"Last changed at {DateTime.Now}"; + } +} diff --git a/aspnetcore/blazor/common/samples/3.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample2.razor b/aspnetcore/blazor/common/samples/3.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample2.razor new file mode 100644 index 000000000000..b4a920afe315 --- /dev/null +++ b/aspnetcore/blazor/common/samples/3.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample2.razor @@ -0,0 +1,25 @@ +@page "/event-handler-example-2" + ++ + +
+ +@code { + private string currentHeading = "Initial heading"; + private string newHeading; + + private async Task UpdateHeading() + { + await Task.Delay(2000); + + currentHeading = $"{newHeading}!!!"; + } +} diff --git a/aspnetcore/blazor/common/samples/3.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample3.razor b/aspnetcore/blazor/common/samples/3.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample3.razor new file mode 100644 index 000000000000..5e6722a08f21 --- /dev/null +++ b/aspnetcore/blazor/common/samples/3.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample3.razor @@ -0,0 +1,21 @@ +@page "/event-handler-example-3" + +@for (var i = 0; i < 4; i++) +{ ++ +
+} + +@mousePointerMessage
+ +@code { + private string mousePointerMessage; + + private void ReportPointerLocation(MouseEventArgs e) + { + mousePointerMessage = $"Mouse coordinates: {e.ScreenX}:{e.ScreenY}"; + } +} diff --git a/aspnetcore/blazor/common/samples/3.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample4.razor b/aspnetcore/blazor/common/samples/3.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample4.razor new file mode 100644 index 000000000000..8f934b888858 --- /dev/null +++ b/aspnetcore/blazor/common/samples/3.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample4.razor @@ -0,0 +1,13 @@ +@page "/event-handler-example-4" + ++ +
+ +@code { + private string heading = "Initial heading"; +} diff --git a/aspnetcore/blazor/common/samples/3.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample5.razor b/aspnetcore/blazor/common/samples/3.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample5.razor new file mode 100644 index 000000000000..142713395074 --- /dev/null +++ b/aspnetcore/blazor/common/samples/3.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample5.razor @@ -0,0 +1,23 @@ +@page "/event-handler-example-5" + ++ +
+} + +@code { + private string heading = "Select a button to learn its position"; + + private void UpdateHeading(MouseEventArgs e, int buttonNumber) + { + heading = $"Selected #{buttonNumber} at {e.ClientX}:{e.ClientY}"; + } +} diff --git a/aspnetcore/blazor/common/samples/3.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample6.razor b/aspnetcore/blazor/common/samples/3.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample6.razor new file mode 100644 index 000000000000..f3ebbf3a2e5b --- /dev/null +++ b/aspnetcore/blazor/common/samples/3.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample6.razor @@ -0,0 +1,17 @@ +@page "/event-handler-example-6" + ++ +
+ +@code { + private int count = 0; + + private void KeyHandler(KeyboardEventArgs e) + { + if (e.Key == "+") + { + count++; + } + } +} diff --git a/aspnetcore/blazor/common/samples/3.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample7.razor b/aspnetcore/blazor/common/samples/3.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample7.razor new file mode 100644 index 000000000000..3a2f10db199c --- /dev/null +++ b/aspnetcore/blazor/common/samples/3.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample7.razor @@ -0,0 +1,34 @@ +@page "/event-handler-example-7" + + + ++ @message +
+ +@code { + private bool stopPropagation = false; + private string message; + + private void OnSelectParentDiv() => + message = $"The parent div was selected. {DateTime.Now}"; + + private void OnSelectChildDiv() => + message = $"A child div was selected. {DateTime.Now}"; +} diff --git a/aspnetcore/blazor/common/samples/3.x/BlazorSample_Server/Pages/event-handling/Parent.razor b/aspnetcore/blazor/common/samples/3.x/BlazorSample_Server/Pages/event-handling/Parent.razor new file mode 100644 index 000000000000..896aa0cb950d --- /dev/null +++ b/aspnetcore/blazor/common/samples/3.x/BlazorSample_Server/Pages/event-handling/Parent.razor @@ -0,0 +1,18 @@ +@page "/parent" + +@message
+ +@code { + private string message; + + private void ShowMessage(MouseEventArgs e) + { + message = $"Blaze a new trail with Blazor! ({e.ScreenX}:{e.ScreenY})"; + } +} diff --git a/aspnetcore/blazor/common/samples/3.x/BlazorSample_Server/Shared/event-handling/Child.razor b/aspnetcore/blazor/common/samples/3.x/BlazorSample_Server/Shared/event-handling/Child.razor new file mode 100644 index 000000000000..2cd0eaed242d --- /dev/null +++ b/aspnetcore/blazor/common/samples/3.x/BlazorSample_Server/Shared/event-handling/Child.razor @@ -0,0 +1,16 @@ ++ +
+ +@code { + [Parameter] + public string Title { get; set; } + + [Parameter] + public RenderFragment ChildContent { get; set; } + + [Parameter] + public EventCallback+ + +
+ ++ +
+ +@code { + private string currentHeading = "Initial heading"; + private string newHeading; + private string checkedMessage = "Not changed yet"; + + private void UpdateHeading() + { + currentHeading = $"{newHeading}!!!"; + } + + private void CheckChanged() + { + checkedMessage = $"Last changed at {DateTime.Now}"; + } +} diff --git a/aspnetcore/blazor/common/samples/3.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample2.razor b/aspnetcore/blazor/common/samples/3.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample2.razor new file mode 100644 index 000000000000..b4a920afe315 --- /dev/null +++ b/aspnetcore/blazor/common/samples/3.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample2.razor @@ -0,0 +1,25 @@ +@page "/event-handler-example-2" + ++ + +
+ +@code { + private string currentHeading = "Initial heading"; + private string newHeading; + + private async Task UpdateHeading() + { + await Task.Delay(2000); + + currentHeading = $"{newHeading}!!!"; + } +} diff --git a/aspnetcore/blazor/common/samples/3.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample3.razor b/aspnetcore/blazor/common/samples/3.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample3.razor new file mode 100644 index 000000000000..5e6722a08f21 --- /dev/null +++ b/aspnetcore/blazor/common/samples/3.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample3.razor @@ -0,0 +1,21 @@ +@page "/event-handler-example-3" + +@for (var i = 0; i < 4; i++) +{ ++ +
+} + +@mousePointerMessage
+ +@code { + private string mousePointerMessage; + + private void ReportPointerLocation(MouseEventArgs e) + { + mousePointerMessage = $"Mouse coordinates: {e.ScreenX}:{e.ScreenY}"; + } +} diff --git a/aspnetcore/blazor/common/samples/3.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample4.razor b/aspnetcore/blazor/common/samples/3.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample4.razor new file mode 100644 index 000000000000..8f934b888858 --- /dev/null +++ b/aspnetcore/blazor/common/samples/3.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample4.razor @@ -0,0 +1,13 @@ +@page "/event-handler-example-4" + ++ +
+ +@code { + private string heading = "Initial heading"; +} diff --git a/aspnetcore/blazor/common/samples/3.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample5.razor b/aspnetcore/blazor/common/samples/3.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample5.razor new file mode 100644 index 000000000000..142713395074 --- /dev/null +++ b/aspnetcore/blazor/common/samples/3.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample5.razor @@ -0,0 +1,23 @@ +@page "/event-handler-example-5" + ++ +
+} + +@code { + private string heading = "Select a button to learn its position"; + + private void UpdateHeading(MouseEventArgs e, int buttonNumber) + { + heading = $"Selected #{buttonNumber} at {e.ClientX}:{e.ClientY}"; + } +} diff --git a/aspnetcore/blazor/common/samples/3.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample6.razor b/aspnetcore/blazor/common/samples/3.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample6.razor new file mode 100644 index 000000000000..f3ebbf3a2e5b --- /dev/null +++ b/aspnetcore/blazor/common/samples/3.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample6.razor @@ -0,0 +1,17 @@ +@page "/event-handler-example-6" + ++ +
+ +@code { + private int count = 0; + + private void KeyHandler(KeyboardEventArgs e) + { + if (e.Key == "+") + { + count++; + } + } +} diff --git a/aspnetcore/blazor/common/samples/3.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample7.razor b/aspnetcore/blazor/common/samples/3.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample7.razor new file mode 100644 index 000000000000..3a2f10db199c --- /dev/null +++ b/aspnetcore/blazor/common/samples/3.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample7.razor @@ -0,0 +1,34 @@ +@page "/event-handler-example-7" + + + ++ @message +
+ +@code { + private bool stopPropagation = false; + private string message; + + private void OnSelectParentDiv() => + message = $"The parent div was selected. {DateTime.Now}"; + + private void OnSelectChildDiv() => + message = $"A child div was selected. {DateTime.Now}"; +} diff --git a/aspnetcore/blazor/common/samples/3.x/BlazorSample_WebAssembly/Pages/event-handling/Parent.razor b/aspnetcore/blazor/common/samples/3.x/BlazorSample_WebAssembly/Pages/event-handling/Parent.razor new file mode 100644 index 000000000000..896aa0cb950d --- /dev/null +++ b/aspnetcore/blazor/common/samples/3.x/BlazorSample_WebAssembly/Pages/event-handling/Parent.razor @@ -0,0 +1,18 @@ +@page "/parent" + +@message
+ +@code { + private string message; + + private void ShowMessage(MouseEventArgs e) + { + message = $"Blaze a new trail with Blazor! ({e.ScreenX}:{e.ScreenY})"; + } +} diff --git a/aspnetcore/blazor/common/samples/3.x/BlazorSample_WebAssembly/Shared/event-handling/Child.razor b/aspnetcore/blazor/common/samples/3.x/BlazorSample_WebAssembly/Shared/event-handling/Child.razor new file mode 100644 index 000000000000..2cd0eaed242d --- /dev/null +++ b/aspnetcore/blazor/common/samples/3.x/BlazorSample_WebAssembly/Shared/event-handling/Child.razor @@ -0,0 +1,16 @@ ++ +
+ +@code { + [Parameter] + public string Title { get; set; } + + [Parameter] + public RenderFragment ChildContent { get; set; } + + [Parameter] + public EventCallback+ + +
+ ++ +
+ +@code { + private string currentHeading = "Initial heading"; + private string newHeading; + private string checkedMessage = "Not changed yet"; + + private void UpdateHeading() + { + currentHeading = $"{newHeading}!!!"; + } + + private void CheckChanged() + { + checkedMessage = $"Last changed at {DateTime.Now}"; + } +} diff --git a/aspnetcore/blazor/common/samples/5.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample2.razor b/aspnetcore/blazor/common/samples/5.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample2.razor new file mode 100644 index 000000000000..b4a920afe315 --- /dev/null +++ b/aspnetcore/blazor/common/samples/5.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample2.razor @@ -0,0 +1,25 @@ +@page "/event-handler-example-2" + ++ + +
+ +@code { + private string currentHeading = "Initial heading"; + private string newHeading; + + private async Task UpdateHeading() + { + await Task.Delay(2000); + + currentHeading = $"{newHeading}!!!"; + } +} diff --git a/aspnetcore/blazor/common/samples/5.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample3.razor b/aspnetcore/blazor/common/samples/5.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample3.razor new file mode 100644 index 000000000000..5e6722a08f21 --- /dev/null +++ b/aspnetcore/blazor/common/samples/5.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample3.razor @@ -0,0 +1,21 @@ +@page "/event-handler-example-3" + +@for (var i = 0; i < 4; i++) +{ ++ +
+} + +@mousePointerMessage
+ +@code { + private string mousePointerMessage; + + private void ReportPointerLocation(MouseEventArgs e) + { + mousePointerMessage = $"Mouse coordinates: {e.ScreenX}:{e.ScreenY}"; + } +} diff --git a/aspnetcore/blazor/common/samples/5.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample4.razor b/aspnetcore/blazor/common/samples/5.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample4.razor new file mode 100644 index 000000000000..8f934b888858 --- /dev/null +++ b/aspnetcore/blazor/common/samples/5.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample4.razor @@ -0,0 +1,13 @@ +@page "/event-handler-example-4" + ++ +
+ +@code { + private string heading = "Initial heading"; +} diff --git a/aspnetcore/blazor/common/samples/5.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample5.razor b/aspnetcore/blazor/common/samples/5.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample5.razor new file mode 100644 index 000000000000..142713395074 --- /dev/null +++ b/aspnetcore/blazor/common/samples/5.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample5.razor @@ -0,0 +1,23 @@ +@page "/event-handler-example-5" + ++ +
+} + +@code { + private string heading = "Select a button to learn its position"; + + private void UpdateHeading(MouseEventArgs e, int buttonNumber) + { + heading = $"Selected #{buttonNumber} at {e.ClientX}:{e.ClientY}"; + } +} diff --git a/aspnetcore/blazor/common/samples/5.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample6.razor b/aspnetcore/blazor/common/samples/5.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample6.razor new file mode 100644 index 000000000000..f3ebbf3a2e5b --- /dev/null +++ b/aspnetcore/blazor/common/samples/5.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample6.razor @@ -0,0 +1,17 @@ +@page "/event-handler-example-6" + ++ +
+ +@code { + private int count = 0; + + private void KeyHandler(KeyboardEventArgs e) + { + if (e.Key == "+") + { + count++; + } + } +} diff --git a/aspnetcore/blazor/common/samples/5.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample7.razor b/aspnetcore/blazor/common/samples/5.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample7.razor new file mode 100644 index 000000000000..3a2f10db199c --- /dev/null +++ b/aspnetcore/blazor/common/samples/5.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample7.razor @@ -0,0 +1,34 @@ +@page "/event-handler-example-7" + + + ++ @message +
+ +@code { + private bool stopPropagation = false; + private string message; + + private void OnSelectParentDiv() => + message = $"The parent div was selected. {DateTime.Now}"; + + private void OnSelectChildDiv() => + message = $"A child div was selected. {DateTime.Now}"; +} diff --git a/aspnetcore/blazor/common/samples/5.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample8.razor b/aspnetcore/blazor/common/samples/5.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample8.razor new file mode 100644 index 000000000000..5cdd12a376f7 --- /dev/null +++ b/aspnetcore/blazor/common/samples/5.x/BlazorSample_Server/Pages/event-handling/EventHandlerExample8.razor @@ -0,0 +1,18 @@ +@page "/event-handler-example-8" + ++ +
+ + + +@code { + private ElementReference exampleInput; + + private async Task ChangeFocus() + { + await exampleInput.FocusAsync(); + } +} diff --git a/aspnetcore/blazor/common/samples/5.x/BlazorSample_Server/Pages/event-handling/Parent.razor b/aspnetcore/blazor/common/samples/5.x/BlazorSample_Server/Pages/event-handling/Parent.razor new file mode 100644 index 000000000000..896aa0cb950d --- /dev/null +++ b/aspnetcore/blazor/common/samples/5.x/BlazorSample_Server/Pages/event-handling/Parent.razor @@ -0,0 +1,18 @@ +@page "/parent" + +@message
+ +@code { + private string message; + + private void ShowMessage(MouseEventArgs e) + { + message = $"Blaze a new trail with Blazor! ({e.ScreenX}:{e.ScreenY})"; + } +} diff --git a/aspnetcore/blazor/common/samples/5.x/BlazorSample_Server/Shared/event-handling/Child.razor b/aspnetcore/blazor/common/samples/5.x/BlazorSample_Server/Shared/event-handling/Child.razor new file mode 100644 index 000000000000..2cd0eaed242d --- /dev/null +++ b/aspnetcore/blazor/common/samples/5.x/BlazorSample_Server/Shared/event-handling/Child.razor @@ -0,0 +1,16 @@ ++ +
+ +@code { + [Parameter] + public string Title { get; set; } + + [Parameter] + public RenderFragment ChildContent { get; set; } + + [Parameter] + public EventCallback+ + +
+ ++ +
+ +@code { + private string currentHeading = "Initial heading"; + private string newHeading; + private string checkedMessage = "Not changed yet"; + + private void UpdateHeading() + { + currentHeading = $"{newHeading}!!!"; + } + + private void CheckChanged() + { + checkedMessage = $"Last changed at {DateTime.Now}"; + } +} diff --git a/aspnetcore/blazor/common/samples/5.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample2.razor b/aspnetcore/blazor/common/samples/5.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample2.razor new file mode 100644 index 000000000000..b4a920afe315 --- /dev/null +++ b/aspnetcore/blazor/common/samples/5.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample2.razor @@ -0,0 +1,25 @@ +@page "/event-handler-example-2" + ++ + +
+ +@code { + private string currentHeading = "Initial heading"; + private string newHeading; + + private async Task UpdateHeading() + { + await Task.Delay(2000); + + currentHeading = $"{newHeading}!!!"; + } +} diff --git a/aspnetcore/blazor/common/samples/5.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample3.razor b/aspnetcore/blazor/common/samples/5.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample3.razor new file mode 100644 index 000000000000..5e6722a08f21 --- /dev/null +++ b/aspnetcore/blazor/common/samples/5.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample3.razor @@ -0,0 +1,21 @@ +@page "/event-handler-example-3" + +@for (var i = 0; i < 4; i++) +{ ++ +
+} + +@mousePointerMessage
+ +@code { + private string mousePointerMessage; + + private void ReportPointerLocation(MouseEventArgs e) + { + mousePointerMessage = $"Mouse coordinates: {e.ScreenX}:{e.ScreenY}"; + } +} diff --git a/aspnetcore/blazor/common/samples/5.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample4.razor b/aspnetcore/blazor/common/samples/5.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample4.razor new file mode 100644 index 000000000000..8f934b888858 --- /dev/null +++ b/aspnetcore/blazor/common/samples/5.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample4.razor @@ -0,0 +1,13 @@ +@page "/event-handler-example-4" + ++ +
+ +@code { + private string heading = "Initial heading"; +} diff --git a/aspnetcore/blazor/common/samples/5.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample5.razor b/aspnetcore/blazor/common/samples/5.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample5.razor new file mode 100644 index 000000000000..142713395074 --- /dev/null +++ b/aspnetcore/blazor/common/samples/5.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample5.razor @@ -0,0 +1,23 @@ +@page "/event-handler-example-5" + ++ +
+} + +@code { + private string heading = "Select a button to learn its position"; + + private void UpdateHeading(MouseEventArgs e, int buttonNumber) + { + heading = $"Selected #{buttonNumber} at {e.ClientX}:{e.ClientY}"; + } +} diff --git a/aspnetcore/blazor/common/samples/5.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample6.razor b/aspnetcore/blazor/common/samples/5.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample6.razor new file mode 100644 index 000000000000..f3ebbf3a2e5b --- /dev/null +++ b/aspnetcore/blazor/common/samples/5.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample6.razor @@ -0,0 +1,17 @@ +@page "/event-handler-example-6" + ++ +
+ +@code { + private int count = 0; + + private void KeyHandler(KeyboardEventArgs e) + { + if (e.Key == "+") + { + count++; + } + } +} diff --git a/aspnetcore/blazor/common/samples/5.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample7.razor b/aspnetcore/blazor/common/samples/5.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample7.razor new file mode 100644 index 000000000000..3a2f10db199c --- /dev/null +++ b/aspnetcore/blazor/common/samples/5.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample7.razor @@ -0,0 +1,34 @@ +@page "/event-handler-example-7" + + + ++ @message +
+ +@code { + private bool stopPropagation = false; + private string message; + + private void OnSelectParentDiv() => + message = $"The parent div was selected. {DateTime.Now}"; + + private void OnSelectChildDiv() => + message = $"A child div was selected. {DateTime.Now}"; +} diff --git a/aspnetcore/blazor/common/samples/5.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample8.razor b/aspnetcore/blazor/common/samples/5.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample8.razor new file mode 100644 index 000000000000..5cdd12a376f7 --- /dev/null +++ b/aspnetcore/blazor/common/samples/5.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample8.razor @@ -0,0 +1,18 @@ +@page "/event-handler-example-8" + ++ +
+ + + +@code { + private ElementReference exampleInput; + + private async Task ChangeFocus() + { + await exampleInput.FocusAsync(); + } +} diff --git a/aspnetcore/blazor/common/samples/5.x/BlazorSample_WebAssembly/Pages/event-handling/Parent.razor b/aspnetcore/blazor/common/samples/5.x/BlazorSample_WebAssembly/Pages/event-handling/Parent.razor new file mode 100644 index 000000000000..896aa0cb950d --- /dev/null +++ b/aspnetcore/blazor/common/samples/5.x/BlazorSample_WebAssembly/Pages/event-handling/Parent.razor @@ -0,0 +1,18 @@ +@page "/parent" + +@message
+ +@code { + private string message; + + private void ShowMessage(MouseEventArgs e) + { + message = $"Blaze a new trail with Blazor! ({e.ScreenX}:{e.ScreenY})"; + } +} diff --git a/aspnetcore/blazor/common/samples/5.x/BlazorSample_WebAssembly/Shared/event-handling/Child.razor b/aspnetcore/blazor/common/samples/5.x/BlazorSample_WebAssembly/Shared/event-handling/Child.razor new file mode 100644 index 000000000000..2cd0eaed242d --- /dev/null +++ b/aspnetcore/blazor/common/samples/5.x/BlazorSample_WebAssembly/Shared/event-handling/Child.razor @@ -0,0 +1,16 @@ ++ +
+ +@code { + [Parameter] + public string Title { get; set; } + + [Parameter] + public RenderFragment ChildContent { get; set; } + + [Parameter] + public EventCallback- - -
+[!code-razor[](~/blazor/common/samples/5.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample1.razor?highlight=10,17,27-30,32-35)] -- -
+::: moniker-end -@code { - private string currentHeading = "Initial heading"; - private string newHeading; - private string checkedMessage = "Not changed yet"; +::: moniker range="< aspnetcore-5.0" - private void UpdateHeading() - { - currentHeading = $"{newHeading}!!!"; - } +[!code-razor[](~/blazor/common/samples/3.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample1.razor?highlight=10,17,27-30,32-35)] - private void CheckChanged() - { - checkedMessage = $"Last changed at {DateTime.Now}"; - } -} -``` +::: moniker-end In the following example, `UpdateHeading`: @@ -75,33 +48,17 @@ In the following example, `UpdateHeading`: `Pages/EventHandlerExample2.razor`: -```razor -@page "/event-handler-example-2" +::: moniker range=">= aspnetcore-5.0" -- - -
+::: moniker-end -@code { - private string currentHeading = "Initial heading"; - private string newHeading; +::: moniker range="< aspnetcore-5.0" - private async Task UpdateHeading() - { - await Task.Delay(2000); +[!code-razor[](~/blazor/common/samples/3.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample2.razor?highlight=10,19-24)] - currentHeading = $"{newHeading}!!!"; - } -} -``` +::: moniker-end ## Event arguments @@ -115,29 +72,17 @@ For events that support an event argument type, specifying an event parameter in `Pages/EventHandlerExample3.razor`: -```razor -@page "/event-handler-example-3" +::: moniker range=">= aspnetcore-5.0" -@for (var i = 0; i < 4; i++) -{ -- -
-} +[!code-razor[](~/blazor/common/samples/5.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample3.razor?highlight=17-20)] -@mousePointerMessage
+::: moniker-end -@code { - private string mousePointerMessage; +::: moniker range="< aspnetcore-5.0" - private void ReportPointerLocation(MouseEventArgs e) - { - mousePointerMessage = $"Mouse coordinates: {e.ScreenX}:{e.ScreenY}"; - } -} -``` +[!code-razor[](~/blazor/common/samples/3.x/BlazorSample_WebAssembly/Pages/event-handling/EventHandlerExample3.razor?highlight=17-20)] + +::: moniker-end Supported