Merge pull request #13855 from v-thepet/vs5

Visual Studio freshness #5

Author: JamesJBarnett

docs/data-tools/pass-data-between-forms.md

@@ -1,7 +1,7 @@
 ---
-title: Pass data between forms controls (.NET Framework)
-description: Pass data between Windows Forms controls in .NET Framework application development with Visual Studio and create a TableAdapter query to fetch customer orders.
-ms.date: 12/15/2023
+title: Pass data between forms (.NET Framework)
+description: Pass data between Windows Forms in .NET Framework application development with Visual Studio and create a TableAdapter query that fetches orders per customer.
+ms.date: 04/22/2025
 ms.topic: how-to
 dev_langs:
 - VB
@@ -16,153 +16,141 @@ author: ghogen
 ms.author: ghogen
 manager: mijacobs
 ms.subservice: data-tools
+
+#customer intent: I want to know how to pass dataset data between forms in a Windows Forms (.NET Framework) application so that I understand one way to pass data between forms.
 ---
 
 # Pass data between forms
 
 [!INCLUDE [Data access tech note](./includes/data-technology-note.md)]
 
-This tutorial provides step-by-step instructions for passing data from one form to another. Using the customers and orders tables from Northwind, one form allows users to select a customer, and a second form displays the selected customer's orders. This tutorial shows how to create a method on the second form that receives data from the first form.
-
-> [!NOTE]
-> This tutorial demonstrates only one way to pass data between forms. There are other options for passing data to a form, including creating a second constructor to receive data, or creating a public property that can be set with data from the first form.
-
-Tasks illustrated in this tutorial include:
-
-- Creating a new **Windows Forms App (.NET Framework)** project.
-
-- Creating and configuring a dataset with the [Data Source Configuration Wizard](../data-tools/media/data-source-configuration-wizard.png).
-
-- Selecting the control to be created on the form when dragging items from the **Data Sources** window. For more information, see [Set the control to be created when dragging from the Data Sources window](../data-tools/set-the-control-to-be-created-when-dragging-from-the-data-sources-window.md).
+This tutorial provides step-by-step instructions for passing data from one form to another. By using the Customers and Orders tables from the Northwind sample database, one form allows users to select a customer, and a second form displays the selected customer's orders. This tutorial shows how to create a method on the second form that receives data from the first form.
 
-- Creating a data-bound control by dragging items from the **Data Sources** window onto a form.
+In this tutorial, you complete the following tasks:
 
-- Creating a second form with a grid to display data.
+- Create a new **Windows Forms App (.NET Framework)** project.
+- Create and configure a dataset by using the **Data Source Configuration Wizard**.
+- Select the control to create on the form when you drag items from the **Data Sources** window. For more information, see [Set the control to be created when dragging from the Data Sources window](set-the-control-to-be-created-when-dragging-from-the-data-sources-window.md).
+- Create a data-bound control by dragging items from the **Data Sources** window onto a form.
+- Create a second form with a grid that displays data.
+- Create a `TableAdapter` query to fetch orders for a specific customer.
+- Pass data between forms.
 
-- Creating a TableAdapter query to fetch orders for a specific customer.
-
-- Passing data between forms.
+>[!NOTE]
+>This tutorial demonstrates only one way to pass data between forms. There are other options for passing data to a form, such as creating a second constructor to receive data, or creating a public property that can be set with data from the first form.
 
 ## Prerequisites
 
-To complete this tutorial, you need the **.NET desktop development** and **Data storage and processing** workloads installed in Visual Studio. To install them, open **Visual Studio Installer** and choose **Modify** (or **More** > **Modify**) next to the version of Visual Studio you want to modify. See [Modify Visual Studio](../install/modify-visual-studio.md).
-
-This tutorial uses SQL Server Express LocalDB and the Northwind sample database.
-
-1. If you don't have SQL Server Express LocalDB, install it either from the [SQL Server Express download page](https://www.microsoft.com/sql-server/sql-server-editions-express), or through the **Visual Studio Installer**. In the Visual Studio Installer, SQL Server Express LocalDB can be installed as part of the **Data storage and processing** workload, or as an individual component.
+- The **.NET desktop development** and **Data storage and processing** workloads installed in Visual Studio. To install them, open **Visual Studio Installer** and choose **Modify**, or **More** > **Modify**, next to the version of Visual Studio you want to use. For more information, see [Modify Visual Studio](../install/modify-visual-studio.md).
 
-2. Install the Northwind sample database by following these steps:
+- SQL Server Express 2019 LocalDB installed either from the [SQL Server downloads page](https://www.microsoft.com/sql-server/sql-server-downloads), or through the **Visual Studio Installer** as part of the **Data storage and processing** workload.
 
-    1. In Visual Studio, open the **SQL Server Object Explorer** window. (SQL Server Object Explorer is installed as part of the **Data storage and processing** workload in the Visual Studio Installer.) Expand the **SQL Server** node. Right-click on your LocalDB instance and select **New Query**.
+- The Northwind sample database, created by following these steps:
 
-       A query editor window opens.
+  1. In Visual Studio, open the **SQL Server Object Explorer** window by selecting it from the **View** menu. SQL Server Object Explorer is installed as part of the **Data storage and processing** workload.
 
-    2. Copy the [Northwind Transact-SQL script](https://github.com/MicrosoftDocs/visualstudio-docs/blob/main/docs/data-tools/samples/northwind.sql?raw=true) to your clipboard. This T-SQL script creates the Northwind database from scratch and populates it with data.
+  1. Expand the **SQL Server** node, right-click your LocalDB instance, and select **New Query** to open a query editor window.
 
-    3. Paste the T-SQL script into the query editor, and then choose the **Execute** button.
+  1. Copy the [Northwind Transact-SQL script](https://github.com/MicrosoftDocs/visualstudio-docs/blob/main/docs/data-tools/samples/northwind.sql?raw=true) to your clipboard. This T-SQL script creates the Northwind database and populates it with data.
 
-       After a short time, the query finishes running and the Northwind database is created.
+  1. Paste the T-SQL script into the query editor, and then select **Execute** at the top of the window to create the Northwind database.
 
 ## Create the Windows Forms app project
 
 1. In Visual Studio, on the **File** menu, select **New** > **Project**.
 
-2. Expand either **Visual C#** or **Visual Basic** in the left-hand pane, then select **Windows Desktop**.
+1. Select either **C#** or **Visual Basic** from the **All languages** dropdown list, **Windows** from the **All platforms** dropdown list, and **Desktop** from the **All project types** list.
 
-3. In the middle pane, select the **Windows Forms App** project type.
+1. Select **Windows Forms App (.NET Framework)** from the project templates list, and then select **Next**.
 
-4. Name the project **PassingDataBetweenForms**, and then choose **OK**.
+1. Name the project **PassingDataBetweenForms**, select **Next**, and then select **Create**.
 
-     The **PassingDataBetweenForms** project is created, and added to **Solution Explorer**.
+The **PassingDataBetweenForms** project is created and added to **Solution Explorer**. The designer view of **Form1** appears in the editor.
 
 ## Create the data source
 
-1. To open the **Data Sources** window, on the **Data** menu, click **Show Data Sources**.
+1. Open the **Data Sources** window by selecting **Project** > **Add New Data Source** on the Visual Studio menu.
 
-2. In the **Data Sources** window, select **Add New Data Source** to start the **Data Source Configuration** wizard.
+1. In the **Data Sources** window, select **Add New Data Source** to start the **Data Source Configuration** wizard.
 
-3. Select **Database** on the **Choose a Data Source Type** page, and then select **Next**.
+1. On the **Choose a Data Source Type** page, select **Database**, and then select **Next**.
 
-4. On the **Choose a database model** page, verify that **Dataset** is specified, and then select **Next**.
+1. On the **Choose a Database Model** page, verify that **Dataset** is specified and select **Next**.
 
-5. On the **Choose your Data Connection** page, do one of the following:
+1. On the **Choose Your Data Connection** page, if a data connection to the Northwind sample database is already available, select it, and proceed to the **Choose your Database Objects** step. Otherwise, select **New Connection**.
 
-    - If a data connection to the Northwind sample database is available in the dropdown list, select it.
+1. On the **Choose Data Source** screen, select **Microsoft SQL Server Database File**, and then select **Continue**.
 
-    - Select **New Connection** to launch the **Add/Modify Connection** dialog box.
+1. On the **Add Connection** screen, select **Browse**, browse to and select the *northwnd.mdf* file, and select **Open**.
 
-6. If your database requires a password and if the option to include sensitive data is enabled, select the option, and then select **Next**.
+1. Either select **Windows Authentication**, or select **SQL Server Authentication** and supply a user name and password to access the database.
 
-7. On the **Save connection string to the Application Configuration file** page, click **Next**.
+1. Select **Test Connection** to test the connection. When the connection succeeds, select **OK**.
 
-8. On the **Choose your Database Objects** page, expand the **Tables** node.
+1. On the **Choose Your Data Connection** page, confirm that the database file appears and select **Next**.
 
-9. Select the **Customers** and **Orders** tables, and then select **Finish**.
+1. Select **No** to the popup question **Would you like to copy the file to your project and modify the connection?**
 
-     The **NorthwindDataSet** is added to your project, and the **Customers** and **Orders** tables appear in the **Data Sources** window.
+1. On the **Save the Connection String to the Application Configuration file** page, select **Yes**. Name the connection *NorthwindConnectionString*, and then select **Next**.
 
-## Create the first form (Form1)
+1. On the **Choose your Database Objects** page, expand the **Tables** node, select the **Customers** and **Orders** tables, name the dataset *NorthwindDataSet*, and then select **Finish**.
 
-You can create a data-bound grid (a <xref:System.Windows.Forms.DataGridView> control), by dragging the **Customers** node from the **Data Sources** window onto the form.
+The **NorthwindDataSet** is added to your project, and the **Customers** and **Orders** tables appear in the **Data Sources** window.
 
-### To create a data-bound grid on the form
+## Populate the first form
 
-- Drag the main **Customers** node from the **Data Sources** window onto **Form1**.
+- To create a data-bound grid, drag the **Customers** node from the **Data Sources** window onto **Form1**.
 
-     A <xref:System.Windows.Forms.DataGridView> and a tool strip (<xref:System.Windows.Forms.BindingNavigator>) for navigating records appear on **Form1**. A [NorthwindDataSet](../data-tools/dataset-tools-in-visual-studio.md), CustomersTableAdapter, <xref:System.Windows.Forms.BindingSource>, and <xref:System.Windows.Forms.BindingNavigator> appear in the component tray.
+  A <xref:System.Windows.Forms.DataGridView> control and a <xref:System.Windows.Forms.BindingNavigator> tool strip for navigating records appear on **Form1**. A [NorthwindDataSet](dataset-tools-in-visual-studio.md), `CustomersTableAdapter`, <xref:System.Windows.Forms.BindingSource>, and <xref:System.Windows.Forms.BindingNavigator> appear in the component tray.
 
 ## Create the second form
 
 Create a second form to pass data to.
 
-1. From the **Project** menu, choose **Add Windows Form**.
+1. From the **Project** menu, choose **Add Form (Windows Forms)**.
 
-2. Leave the default name of **Form2**, and click **Add**.
+1. Leave the default name of **Form2**, and select **Add**.
 
-3. Drag the main **Orders** node from the **Data Sources** window onto **Form2**.
+1. Drag the main **Orders** node from the **Data Sources** window onto **Form2**.
 
-     A <xref:System.Windows.Forms.DataGridView> and a tool strip (<xref:System.Windows.Forms.BindingNavigator>) for navigating records appear on **Form2**. A [NorthwindDataSet](../data-tools/dataset-tools-in-visual-studio.md), CustomersTableAdapter, <xref:System.Windows.Forms.BindingSource>, and <xref:System.Windows.Forms.BindingNavigator> appear in the component tray.
+   A <xref:System.Windows.Forms.DataGridView> and a <xref:System.Windows.Forms.BindingNavigator> tool strip for navigating records appear on **Form2**. A [NorthwindDataSet](dataset-tools-in-visual-studio.md), `CustomersTableAdapter`, <xref:System.Windows.Forms.BindingSource>, and <xref:System.Windows.Forms.BindingNavigator> appear in the component tray.
 
-4. Delete the **OrdersBindingNavigator** from the component tray.
-
-     The **OrdersBindingNavigator** disappears from **Form2**.
+1. Delete the **OrdersBindingNavigator** from the component tray. The **BindingNavigator** disappears from **Form2**.
 
 ## Add a TableAdapter query
 
-Add a TableAdapter query to Form2 to load orders for the selected customer on Form1.
+Add a `TableAdapter` query to Form2 that loads orders for the customer selected on Form1.
 
 1. Double-click the **NorthwindDataSet.xsd** file in **Solution Explorer**.
 
-2. Right-click the **OrdersTableAdapter**, and select **Add Query**.
-
-3. Leave the default option of **Use SQL statements**, and then select **Next**.
+1. Right-click **OrdersTableAdapter** in the **Orders** table, and select **Add** > **Query**.
 
-4. Leave the default option of **SELECT which returns rows**, and then select **Next**.
+1. Leave the default option of **Use SQL statements** and select **Next**.
 
-5. Add a `WHERE` clause to the query, to return `Orders` based on the `CustomerID`. The query should be similar to the following:
+1. Leave the default option of **SELECT which returns rows** and select **Next**.
 
-    ```sql
-    SELECT OrderID, CustomerID, EmployeeID, OrderDate, RequiredDate, ShippedDate, ShipVia, Freight, ShipName, ShipAddress, ShipCity, ShipRegion, ShipPostalCode, ShipCountry
-    FROM Orders
-    WHERE CustomerID = @CustomerID
-    ```
+1. In **What data should the table load**, to return `Orders` based on the `CustomerID`, add a `WHERE` clause to the end of the query. The final query should look similar to the following code:
 
-    > [!NOTE]
-    > Verify the correct parameter syntax for your database. For example, in Microsoft Access, the `WHERE` clause would look like: `WHERE CustomerID = ?`.
+   ```sql
+   SELECT OrderID, CustomerID, OrderDate, RequiredDate, ShippedDate, ShipVia, Freight, ShipName, ShipAddress, ShipCity, ShipRegion, ShipPostalCode, ShipCountry
+   FROM Orders
+   WHERE CustomerID = @CustomerID
+   ```
 
-6. Click **Next**.
+   > [!NOTE]
+   > Use the correct parameter syntax for your database. For example, in Microsoft Access, the `WHERE` clause would look like `WHERE CustomerID = ?`.
 
-7. For the **Fill a DataTableMethod Name**, type `FillByCustomerID`.
+1. Select **Next**.
 
-8. Clear the **Return a DataTable** option, and then select **Next**.
+1. On the **Choose Methods to Generate** screen, select **Fill a DataTable** and enter *FillByCustomerID*.
 
-9. Click **Finish**.
+1. Deselect the **Return a DataTable** option, and then select **Finish**.
 
 ## Create a method on Form2 to pass data to
 
-1. Right-click **Form2**, and select **View Code** to open **Form2** in the **Code Editor**.
+1. Right-click in **Form2** and select **View Code** to open the **Form2** code in the editor.
 
-2. Add the following code to **Form2** after the `Form2_Load` method:
+1. In the **Form2** code, remove the contents of the `Form2_Load` method, and add the following code after the `Form2_Load` method:
 
 ### [C#](#tab/csharp)
 
@@ -175,15 +163,13 @@ Add a TableAdapter query to Form2 to load orders for the selected customer on Fo
 
 ## Create a method on Form1 to pass data and display Form2
 
-1. In **Form1**, right-click the Customer data grid, and then select **Properties**.
-
-2. In the **Properties** window, click **Events**.
+1. In the Designer view of **Form1**, right-click the Customer data grid, and then select **Properties**.
 
-3. Double-click the **CellDoubleClick** event.
+1. In the **Properties** window, select the **Events** icon in the top toolbar.
 
-     The code editor appears.
+1. Double-click the **DoubleClick** event to open the code editor.
 
-4. Update the method definition to match the following sample:
+1. In the code editor, update the method definition to match the following sample:
 
 ### [C#](#tab/csharp)
 
@@ -194,20 +180,20 @@ Add a TableAdapter query to Form2 to load orders for the selected customer on Fo
 :::code language="vb" source="../snippets/visualbasic/VS_Snippets_VBCSharp/VbRaddataDisplaying/VB/Form1.vb" id="Snippet2":::
 ---
 
-## Run the app
+## Run and test the app
 
-- Press **F5** to run the application.
+1. Press **F5** to run the application.
 
-- Double-click a customer record in **Form1** to open **Form2** with that customer's orders.
+1. In the application, double-click a customer record in **Form1** to open **Form2** with that customer's orders.
 
 ## Next steps
 
-Depending on your application requirements, there are several steps you might want to perform after passing data between forms. Some enhancements you could make to this tutorial include:
+Depending on your application requirements, you can do several steps after passing data between forms. Some enhancements you could make to this tutorial include:
 
-- Editing the dataset to add or remove database objects. For more information, see [Create and configure datasets](../data-tools/create-and-configure-datasets-in-visual-studio.md).
+- Editing the dataset to add or remove database objects. For more information, see [Create and configure datasets](create-and-configure-datasets-in-visual-studio.md).
 
-- Adding functionality to save data back to the database. For more information, see [Save data back to the database](../data-tools/save-data-back-to-the-database.md).
+- Adding functionality to save data back to the database. For more information, see [Save data back to the database](save-data-back-to-the-database.md).
 
 ## Related content
 
-- [Bind Windows Forms controls to data in Visual Studio](../data-tools/bind-windows-forms-controls-to-data-in-visual-studio.md)
+- [Bind Windows Forms controls to data in Visual Studio](bind-windows-forms-controls-to-data-in-visual-studio.md)