EventArgs F# snippets (#7710)

Author: albert-du

snippets/fsharp/System/EventArgs/Overview/fs.fsproj

@@ -0,0 +1,11 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net6.0</TargetFramework>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <Compile Include="programwithdata.fs" />
+    <Compile Include="programnodata.fs" />
+  </ItemGroup>
+</Project>

snippets/fsharp/System/EventArgs/Overview/programnodata.fs

@@ -0,0 +1,31 @@
+module programnodata
+
+// <snippet5>
+open System
+
+type Counter(threshold) =
+    let mutable total = 0
+
+    let thresholdReached = Event<_>()
+
+    member this.Add(x) =
+        total <- total + x
+        if total >= threshold then
+            thresholdReached.Trigger(this, EventArgs.Empty)
+
+    [<CLIEvent>]
+    member _.ThresholdReached = thresholdReached.Publish
+
+let c_ThresholdReached(sender, arg) =
+    printfn "The threshold was reached."
+    exit 0
+
+let c = Counter(Random().Next 10)
+c.ThresholdReached.Add c_ThresholdReached
+
+printfn "press 'a' key to increase total"
+while Console.ReadKey(true).KeyChar = 'a' do
+    printfn "adding one"
+    c.Add 1
+
+// </snippet5>

snippets/fsharp/System/EventArgs/Overview/programwithdata.fs

@@ -0,0 +1,36 @@
+module programwithdata
+
+// <snippet6>
+open System
+
+type ThresholdReachedEventArgs(threshold, timeReached) =
+    inherit EventArgs()
+    member _.Threshold = threshold
+    member _.TimeReached = timeReached
+
+type Counter(threshold) =
+    let mutable total = 0
+
+    let thresholdReached = Event<_>()
+
+    member this.Add(x) =
+        total <- total + x
+        if total >= threshold then
+            let args = ThresholdReachedEventArgs(threshold, DateTime.Now)
+            thresholdReached.Trigger(this, args)
+
+    [<CLIEvent>]
+    member _.ThresholdReached = thresholdReached.Publish
+
+let c_ThresholdReached(sender, e: ThresholdReachedEventArgs) =
+    printfn $"The threshold of {e.Threshold} was reached at {e.TimeReached}."
+    exit 0
+
+let c = Counter(Random().Next 10)
+c.ThresholdReached.Add c_ThresholdReached
+
+printfn "press 'a' key to increase total"
+while Console.ReadKey(true).KeyChar = 'a' do
+    printfn "adding one"
+    c.Add 1
+// </snippet6>

xml/System/EventArgs.xml

@@ -68,6 +68,7 @@
   
  :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/eventsoverview/cpp/programwithdata.cpp" id="Snippet6":::
  :::code language="csharp" source="~/snippets/csharp/System/EventArgs/Overview/programwithdata.cs" id="Snippet6":::
+ :::code language="fsharp" source="~/snippets/fsharp/System/EventArgs/Overview/programwithdata.fs" id="Snippet6":::
  :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/eventsoverview/vb/module1withdata.vb" id="Snippet6":::  
   
  ]]></format>
@@ -177,6 +178,7 @@
  The following example shows a simple counting application that raises an event when a threshold is equaled or exceeded. The <xref:System.EventArgs.Empty> field is passed to the `OnThresholdReached` method.  
   
  :::code language="csharp" source="~/snippets/csharp/System/EventArgs/Overview/programnodata.cs" id="Snippet5":::
+ :::code language="fsharp" source="~/snippets/fsharp/System/EventArgs/Overview/programnodata.fs" id="Snippet5":::
  :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/eventsoverview/vb/module1nodata.vb" id="Snippet5":::  
   
  ]]></format>
@@ -185,6 +187,7 @@
         <related type="Article" href="/dotnet/standard/events/how-to-raise-and-consume-events">How to: Raise and Consume Events</related>
         <related type="Article" href="/dotnet/visual-basic/programming-guide/language-features/events/">Events (Visual Basic)</related>
         <related type="Article" href="/dotnet/csharp/programming-guide/events/">Events (C# Programming Guide)</related>
+        <related type="Article" href="/dotnet/fsharp/language-reference/members/events/">Events (F#)</related>
         <related type="Article" href="https://docs.microsoft.com/previous-versions/windows/apps/hh758286(v=win.10)">Events and routed events overview (Windows store apps)</related>
       </Docs>
     </Member>

xml/System/EventHandler.xml

@@ -87,6 +87,7 @@
   
  :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/eventsoverview/cpp/programwithdata.cpp" id="Snippet6":::
  :::code language="csharp" source="~/snippets/csharp/System/EventArgs/Overview/programwithdata.cs" id="Snippet6":::
+ :::code language="fsharp" source="~/snippets/fsharp/System/EventArgs/Overview/programwithdata.fs" id="Snippet6":::
  :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/eventsoverview/vb/module1withdata.vb" id="Snippet6":::  
   
  ]]></format>
@@ -98,6 +99,7 @@
     <related type="Article" href="/dotnet/standard/events/how-to-raise-and-consume-events">How to: Raise and Consume Events</related>
     <related type="Article" href="/dotnet/visual-basic/programming-guide/language-features/events/">Events (Visual Basic)</related>
     <related type="Article" href="/dotnet/csharp/programming-guide/events/">Events (C# Programming Guide)</related>
+    <related type="Article" href="/dotnet/fsharp/language-reference/members/events/">Events (F#)</related>
     <related type="Article" href="https://docs.microsoft.com/previous-versions/windows/apps/hh758286(v=win.10)">Events and routed events overview (Windows store apps)</related>
   </Docs>
 </Type>

xml/System/EventHandler`1.xml

@@ -90,6 +90,7 @@
   
  :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/eventsoverview/cpp/programwithdata.cpp" id="Snippet6":::
  :::code language="csharp" source="~/snippets/csharp/System/EventArgs/Overview/programwithdata.cs" id="Snippet6":::
+ :::code language="fsharp" source="~/snippets/fsharp/System/EventArgs/Overview/programwithdata.fs" id="Snippet6":::
  :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/eventsoverview/vb/module1withdata.vb" id="Snippet6":::  
   
  ]]></format>
@@ -102,6 +103,7 @@
     <related type="Article" href="/dotnet/standard/events/how-to-raise-and-consume-events">How to: Raise and Consume Events</related>
     <related type="Article" href="/dotnet/visual-basic/programming-guide/language-features/events/">Events (Visual Basic)</related>
     <related type="Article" href="/dotnet/csharp/programming-guide/events/">Events (C# Programming Guide)</related>
+    <related type="Article" href="/dotnet/fsharp/language-reference/members/events/">Events (F#)</related>
     <related type="Article" href="https://docs.microsoft.com/previous-versions/windows/apps/hh758286(v=win.10)">Events and routed events overview (Windows store apps)</related>
   </Docs>
 </Type>