Walkthrough for Get Started with WinForms (#3968)

Co-authored-by: Klaus Löffelmann <9663150+KlausLoeffelmann@users.noreply.github.com>

entity-framework/core/change-tracking/entity-entries.md

@@ -592,7 +592,7 @@ For example:
 -->
 [!code-csharp[Using_DbSet_Local_to_query_tracked_entities_4](../../../samples/core/ChangeTracking/AccessingTrackedEntities/Samples.cs?name=Using_DbSet_Local_to_query_tracked_entities_4)]
 
-See [Get Started with WPF](xref:core/get-started/wpf) for more information on WPF data binding with EF Core.
+See [Get Started with WPF](xref:core/get-started/wpf) for more information on WPF data binding with EF Core, and [Get Started with Windows Forms](xref:core/get-started/winforms) for more information on Windows Forms data binding with EF Core.
 
 > [!TIP]
 > The local view for a given DbSet instance is created lazily when first accessed and then cached. LocalView creation itself is fast and it does not use significant memory. However, it does call [DetectChanges](xref:core/change-tracking/change-detection), which can be slow for large numbers of entities. The collections created by `ToObservableCollection` and `ToBindingList` are also created lazily and then cached. Both of these methods create new collections, which can be slow and use a lot of memory when thousands of entities are involved.

entity-framework/index.yml

@@ -60,6 +60,8 @@ additionalContent:
             text: "ASP.NET Core MVC web app accessing SQL Server with EF Core"
           - url: core/get-started/wpf.md
             text: "WPF .NET Core app accessing SQLite with EF Core"
+          - url: core/get-started/winforms.md
+            text: "Windows Forms .NET Core app accessing SQLite with EF Core"
           - url: core/get-started/xamarin.md
             text: "Xamarin mobile app accessing SQLite with EF Core"
       # Card
@@ -92,7 +94,7 @@ additionalContent:
             text: "Blazor Server"
           - url: core/get-started/wpf.md
             text: "Windows Presentation Foundation (WPF)"
-          - url: ef6/fundamentals/databinding/winforms.md
+          - url: core/get-started/winforms.md
             text: "Windows Forms (WinForms)"
           - url: core/get-started/xamarin.md
             text: "Xamarin"

entity-framework/toc.yml

@@ -53,7 +53,8 @@
         href: /aspnet/core/blazor/blazor-server-ef-core
       - name: WPF .NET Core tutorial
         href: core/get-started/wpf.md
-      #- name: Windows Forms tutorial
+      - name: Windows Forms tutorial
+        href: core/get-started/winforms.md
       - name: Xamarin tutorial
         href: core/get-started/xamarin.md
 

samples/core/WinForms/GetStartedWinForms/GetStartedWinForms.sln

@@ -0,0 +1,25 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio Version 17
+VisualStudioVersion = 17.3.32728.150
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "GetStartedWinForms", "GetStartedWinForms\GetStartedWinForms.csproj", "{4F4ED10B-6E60-4A22-88D2-553089460ADB}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{4F4ED10B-6E60-4A22-88D2-553089460ADB}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{4F4ED10B-6E60-4A22-88D2-553089460ADB}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{4F4ED10B-6E60-4A22-88D2-553089460ADB}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{4F4ED10B-6E60-4A22-88D2-553089460ADB}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+	GlobalSection(ExtensibilityGlobals) = postSolution
+		SolutionGuid = {871AF531-D09B-42A7-8D8A-4293B23EF80B}
+	EndGlobalSection
+EndGlobal

samples/core/WinForms/GetStartedWinForms/GetStartedWinForms/Category.cs

@@ -0,0 +1,12 @@
+using Microsoft.EntityFrameworkCore.ChangeTracking;
+
+namespace GetStartedWinForms;
+
+public class Category
+{
+    public int CategoryId { get; set; }
+
+    public string? Name { get; set; }
+
+    public virtual ObservableCollectionListSource<Product> Products { get; } = new();
+}

samples/core/WinForms/GetStartedWinForms/GetStartedWinForms/Form1.cs

@@ -0,0 +1,59 @@
+using Microsoft.EntityFrameworkCore;
+using System.ComponentModel;
+
+namespace GetStartedWinForms
+{
+    public partial class MainForm : Form
+    {
+        private ProductsContext? dbContext;
+
+        public MainForm()
+        {
+            InitializeComponent();
+        }
+
+        protected override void OnLoad(EventArgs e)
+        {
+            base.OnLoad(e);
+
+            this.dbContext = new ProductsContext();
+
+            // Uncomment the line below to start fresh with a new database.
+            // this.dbContext.Database.EnsureDeleted();
+            this.dbContext.Database.EnsureCreated();
+
+            this.dbContext.Categories.Load();
+
+            this.categoryBindingSource.DataSource = dbContext.Categories.Local.ToBindingList();
+        }
+
+        protected override void OnClosing(CancelEventArgs e)
+        {
+            base.OnClosing(e);
+
+            this.dbContext?.Dispose();
+            this.dbContext = null;
+        }
+
+        private void dataGridViewCategories_SelectionChanged(object sender, EventArgs e)
+        {
+            if (this.dbContext != null)
+            {
+                var category = (Category)this.dataGridViewCategories.CurrentRow.DataBoundItem;
+
+                if (category != null)
+                {
+                    this.dbContext.Entry(category).Collection(e => e.Products).Load();
+                }
+            }
+        }
+
+        private void buttonSave_Click(object sender, EventArgs e)
+        {
+            this.dbContext!.SaveChanges();
+
+            this.dataGridViewCategories.Refresh();
+            this.dataGridViewProducts.Refresh();
+        }
+    }
+}

samples/core/WinForms/GetStartedWinForms/GetStartedWinForms/Form1.resx

@@ -0,0 +1,66 @@
+<root>
+  <xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
+    <xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
+    <xsd:element name="root" msdata:IsDataSet="true">
+      <xsd:complexType>
+        <xsd:choice maxOccurs="unbounded">
+          <xsd:element name="metadata">
+            <xsd:complexType>
+              <xsd:sequence>
+                <xsd:element name="value" type="xsd:string" minOccurs="0" />
+              </xsd:sequence>
+              <xsd:attribute name="name" use="required" type="xsd:string" />
+              <xsd:attribute name="type" type="xsd:string" />
+              <xsd:attribute name="mimetype" type="xsd:string" />
+              <xsd:attribute ref="xml:space" />
+            </xsd:complexType>
+          </xsd:element>
+          <xsd:element name="assembly">
+            <xsd:complexType>
+              <xsd:attribute name="alias" type="xsd:string" />
+              <xsd:attribute name="name" type="xsd:string" />
+            </xsd:complexType>
+          </xsd:element>
+          <xsd:element name="data">
+            <xsd:complexType>
+              <xsd:sequence>
+                <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
+                <xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
+              </xsd:sequence>
+              <xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
+              <xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
+              <xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
+              <xsd:attribute ref="xml:space" />
+            </xsd:complexType>
+          </xsd:element>
+          <xsd:element name="resheader">
+            <xsd:complexType>
+              <xsd:sequence>
+                <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
+              </xsd:sequence>
+              <xsd:attribute name="name" type="xsd:string" use="required" />
+            </xsd:complexType>
+          </xsd:element>
+        </xsd:choice>
+      </xsd:complexType>
+    </xsd:element>
+  </xsd:schema>
+  <resheader name="resmimetype">
+    <value>text/microsoft-resx</value>
+  </resheader>
+  <resheader name="version">
+    <value>2.0</value>
+  </resheader>
+  <resheader name="reader">
+    <value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
+  </resheader>
+  <resheader name="writer">
+    <value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
+  </resheader>
+  <metadata name="categoryBindingSource.TrayLocation" type="System.Drawing.Point, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a">
+    <value>17, 17</value>
+  </metadata>
+  <metadata name="productsBindingSource.TrayLocation" type="System.Drawing.Point, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a">
+    <value>195, 17</value>
+  </metadata>
+</root>

samples/core/WinForms/GetStartedWinForms/GetStartedWinForms/GetStartedWinForms.csproj

@@ -0,0 +1,15 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>WinExe</OutputType>
+    <TargetFramework>net7.0-windows</TargetFramework>
+    <Nullable>enable</Nullable>
+    <UseWindowsForms>true</UseWindowsForms>
+    <ImplicitUsings>enable</ImplicitUsings>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.EntityFrameworkCore.Sqlite" Version="7.0.0-preview.6.22329.4" />
+  </ItemGroup>
+
+</Project>

samples/core/WinForms/GetStartedWinForms/GetStartedWinForms/Product.cs

@@ -0,0 +1,13 @@
+using System.ComponentModel;
+
+namespace GetStartedWinForms;
+
+public class Product
+{
+    public int ProductId { get; set; }
+
+    public string? Name { get; set; }
+
+    public int CategoryId { get; set; }
+    public virtual Category Category { get; set; } = null!;
+}