You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: Learn about the launch settings for Container Tools that are related to how Visual Studio handles containerized apps.
5
5
ms.author: ghogen
6
-
ms.date: 08/15/2019
6
+
ms.date: 10/7/2024
7
7
ms.subservice: container-tools
8
8
ms.topic: reference
9
9
---
@@ -12,7 +12,11 @@ ms.topic: reference
12
12
13
13
In the *Properties* folder in an ASP.NET Core project, you can find the `launchSettings.json` file, which contains settings that control how your web app is started on your development machine. For detailed information on how this file is used in ASP.NET development, see [Use multiple environments in ASP.NET Core](/aspnet/core/fundamentals/environments?view=aspnetcore-2.2&preserve-view=true).
14
14
15
-
You can edit this file directly, but in Visual Studio IDE, you can also edit the properties in this file through the UI. Choose the dropdown list next to the launch option (for example, `Docker` or `.NET SDK`), and then choose **Debug Properties**.
15
+
You can edit this file directly, but in Visual Studio IDE, you can also edit the properties in this file through the UI. Choose the dropdown list next to the launch option (for example, `Docker` or `.NET SDK`), and then choose **Debug Properties** for a single-container project.
16
+
17
+
18
+
19
+
For Docker Compose, choose **Manage Docker Compose Launch Settings**, and see [Launch a subset of compose services](launch-profiles.md).
16
20
17
21
In *launchSettings.json*, the settings in the **Docker** section are related to how Visual Studio handles containerized apps.
18
22
@@ -61,22 +65,28 @@ The following table shows the properties that can be set in this section:
| commandLineArgs |`"commandLineArgs": "--mysetting myvalue"`| These command-line arguments for starting your app are used when launching your project in the container. |
67
-
| containerRunArguments|`"containerRunArguments": "-l mylabel=value"`|Like `dockerfileRunArguments`, but for use with the .NET SDK container build type. |
68
-
|DockerfileRunArguments|`dockerfileRunArguments": "-l mylabel=value"`|Additional arguments to pass to the [`docker run`](https://docs.docker.com/engine/reference/commandline/run/) command. <br>/<br/> This setting only applies to projects that use the Dockerfile container build type. <br/><br/> In Visual Studio 17.3 and later, you can use the following replacement tokens added:<br/><br/> - `{ProjectDir}` - Full path to the project directory. <br/><br/> - `{OutDir}` - The value of the MSBuild property OutDir.|
69
-
| environmentVariables |`"environmentVariables":` {<br/> `"ASPNETCORE_URLS": "https://+:443;http://+:80"`, <br/> `"ASPNETCORE_HTTPS_PORT": "44381"` <br/> } | These environment variable values are passed to the process when it's launched in the container. |
70
-
| httpPort |`"httpPort": 24051`| This port on the host is mapped to the container's port 80 when launching the container. |
71
-
| launchBrowser |`"launchBrowser": true`| Indicates whether to launch the browser after successfully launching the project. |
72
-
| launchBrowserTimeout |`"launchBrowserTimeout": 1`| The maximum amount of time (in seconds) to wait for the app to be ready before launching the browser. |
73
-
| launchUrl |`"launchUrl": "{Scheme}://{ServiceHost}:{ServicePort}"`| This URL is used when launching the browser. Supported replacement tokens for this string are: <br/><br/> - `{Scheme}` - Replaced with either `http` or `https`, depending on whether SSL is used. <br/><br/> - `{ServiceHost}` - Usually replaced with `localhost`. <br/> When you're targeting Windows containers on Windows 10 RS3 or older, though, it's replaced with the container's IP. <br/><br/> - `{ServicePort}` - Usually replaced with either sslPort or httpPort, depending on whether SSL is used. <br/> When you're targeting Windows containers on Windows 10 RS3 or older, though, it's replaced with either `443` or `80`, depending on whether SSL is used. |
74
-
| publishAllPorts |`"publishAllPorts": true`| If true, pass `-P` to `docker run`, which publishes all exposed ports to a random port. See [Docker documentation](https://docs.docker.com/engine/reference/commandline/run/). However, when you specify `sslPort`, Visual Studio still passes `-p 5002:443`, so your service should still be listening on port 5002.|
75
-
| sslPort |`"sslPort": 44381`| This port on the host is mapped to the container's port 443 when launching the container. |
76
-
| useSSL |`"useSSL": true`| Indicates whether to use SSL when launching the project. If `useSSL` isn't specified, then SSL is used when `sslPort > 0`. |
68
+
| Property in Debug Profile UI | Setting name in launchSettings.json |Example|Description|
69
+
| - | - | - | - |
70
+
|Command line arguments| commandLineArgs |`"commandLineArgs": "--mysetting myvalue"`| These command-line arguments for starting your app are used when launching your project in the container. |
71
+
|Container run arguments| containerRunArguments<br/>ContainerRunArguments|`"containerRunArguments": "-l mylabel=value"`| Additional arguments to pass to the [`docker run`](https://docs.docker.com/engine/reference/commandline/run/) command. <br><br/> (Use the lowercase version in Visual Studio 17.12 and later. The uppercase version was introduced in Visual Studio 17.9 and is provided for backward compatibility.) <br/><br/> You can use the following replacement tokens:<br/><br/> - `{ProjectDir}` - Full path to the project directory. <br/><br/> - `{OutDir}` - The value of the MSBuild property OutDir. |
72
+
|N/A|DockerfileRunArguments|`dockerfileRunArguments": "-l mylabel=value"`|Like `containerRunArguments`, but only for projects that use the Dockerfile build type. For Visual Studio 17.12 and later, it is recommended to use `containerRunArguments` instead.|
73
+
|Environment Variables| environmentVariables |`"environmentVariables":` {<br/> `"ASPNETCORE_URLS": "https://+:443;http://+:80"`, <br/> `"ASPNETCORE_HTTPS_PORT": "44381"` <br/> } | These environment variable values are passed to the process when it's launched in the container. |
74
+
|Container Name| containerName |`mycontainer`| (17.12 and later) A name for the container matching the regular expression `[a-zA-Z0-9][a-zA-Z0-9_.-]`.|
75
+
|Container environment files| containerRunEnvironmentFiles |`"containerRunEnvironmentFiles": "abc.env;xyz.env"`| (17.12 and later) A list of environment variable files (`.env` files) separated by semicolons. See [.env file syntax](https://docs.docker.com/compose/how-tos/environment-variables/variable-interpolation/#env-file-syntax). |
76
+
|Http Port| httpPort |`"httpPort": 24051`| This port on the host is mapped to the container's port 80 when launching the container. |
77
+
|Launch Browser| launchBrowser |`"launchBrowser": true`| Indicates whether to launch the browser after successfully launching the project. |
78
+
|N/A| launchBrowserTimeout |`"launchBrowserTimeout": 1`| The maximum amount of time (in seconds) to wait for the app to be ready before launching the browser (Docker Compose only). |
79
+
|Url | launchUrl |`"launchUrl": "{Scheme}://{ServiceHost}:{ServicePort}"`| This URL is used when launching the browser. Supported replacement tokens for this string are: <br/><br/> - `{Scheme}` - Replaced with either `http` or `https`, depending on whether SSL is used. <br/><br/> - `{ServiceHost}` - Usually replaced with `localhost`. <br/> When you're targeting Windows containers on Windows 10 RS3 or older, though, it's replaced with the container's IP. <br/><br/> - `{ServicePort}` - Usually replaced with either sslPort or httpPort, depending on whether SSL is used. <br/> When you're targeting Windows containers on Windows 10 RS3 or older, though, it's replaced with either `443` or `80`, depending on whether SSL is used. |
80
+
| Publish all ports | publishAllPorts |`"publishAllPorts": true`| If true, pass `-P` to `docker run`, which publishes all exposed ports to a random port. See [Docker documentation](https://docs.docker.com/engine/reference/commandline/run/). However, when you specify `sslPort`, Visual Studio still passes `-p 5002:443`, so your service should still be listening on port 5002.|
81
+
| Ssl Port| sslPort |`"sslPort": 44381`| This port on the host is mapped to the container's port 443 when launching the container. |
82
+
| N/A | useSSL |`"useSSL": true`| Indicates whether to use SSL when launching the project. If `useSSL` isn't specified, then SSL is used when `sslPort > 0`. |
83
+
84
+
Not all settings are available in the UI, for example, `useSSL`. To change those settings, edit `launchSettings.json` directly.
85
+
86
+
The setting `DockerfileRunArguments` is superceded in Visual Studio 2022 17.12 and later by `containerRunArguments`, which can be set in the Launch Profiles UI as `Container run arguments`.
77
87
78
88
> [!NOTE]
79
-
> If the same settings, for example, `DockerfileRunArguments`, is found in both the project file and in the launch settings file, the value in the launch settings file takes precedence.
89
+
> If the same setting is found in both the project file and in the launch settings file, the value in the launch settings file takes precedence.
If you're using C#, be sure you put the code after the opening curly brace and just after the class declaration (`public partial class Form1 : Form`). If you're using Visual Basic, put the code right after the class declaration (`Public Class Form1`).
65
63
66
64
You can use list objects to keep track of different types of items.
Copy file name to clipboardExpand all lines: docs/get-started/csharp/tutorial-windows-forms-math-quiz-add-math-problems.md
+6-8Lines changed: 6 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ ms.custom: vs-acquisition
5
5
dev_langs:
6
6
- "CSharp"
7
7
- "VB"
8
-
ms.date: 03/15/2023
8
+
ms.date: 10/18/2024
9
9
ms.topic: tutorial
10
10
author: anandmeg
11
11
ms.author: meghaanand
@@ -37,7 +37,7 @@ This tutorial builds on a previous tutorial, [Create a math quiz WinForms app](t
37
37
38
38
1. On the menu bar, select **View** > **Code**. *Form1.cs* or *Form1.vb* appears, depending on the programming language that you're using, so that you can view the code behind the form.
39
39
40
-
1. Create a <xref:System.Random> object by adding a `new` statement near the top of the code.
40
+
1. Create a <xref:System.Random> object by adding a `new` statement near the top of the code in *Form1.cs* or *Form1.vb*.
You can use `new` statements like this one to create buttons, labels, panels, OpenFileDialogs, ColorDialogs, SoundPlayers, Randoms, and even forms. These items are called *objects*.
52
50
53
51
When you run your program, the form is started. The code behind it creates a Random object and names it **randomizer**.
54
52
55
53
Your quiz needs variables to store the random numbers that it creates for each problem. Before using variables, you declare them, which means listing their names and data types.
56
54
57
-
1. Add two integer variables to the form, and name them **addend1** and **addend2**.
55
+
1. Add two integer variables to the form, and name them **addend1** and **addend2** in *Form1.cs* or *Form1.vb*.
58
56
59
57
> [!NOTE]
60
58
> An integer variable is known as an *int* in C# or an *Integer* in Visual Basic. This kind of variable stores a positive or negative number from -2147483648 through 2147483647 and can store only whole numbers, not decimals.
@@ -68,7 +66,7 @@ This tutorial builds on a previous tutorial, [Create a math quiz WinForms app](t
1. Add a method that's named `StartTheQuiz()`. This method uses the Random object's <xref:System.Random.Next> method to generate random numbers for the labels. `StartTheQuiz()` will eventually fill in all the problems and then start the timer, so add this information to the summary comment. The function should look like the following code.
69
+
1. Add a method that's named `StartTheQuiz()`*Form1.cs* or *Form1.vb*. This method uses the Random object's <xref:System.Random.Next> method to generate random numbers for the labels. `StartTheQuiz()` will eventually fill in all the problems and then start the timer, so add this information to the summary comment. The function should look like the following code.
@@ -94,7 +92,7 @@ This tutorial builds on a previous tutorial, [Create a math quiz WinForms app](t
94
92
95
93
The next step is to declare variables and provide random values for the other math problems.
96
94
97
-
1. Add integer variables for the remaining math problems to your form, after the addition problem variables. The code should look like the following sample.
95
+
1. Add integer variables for the remaining math problems to your form, after the addition problem variables. The code in *Form1.cs* or *Form1.vb*should look like the following sample.
1. Modify the `StartTheQuiz()` method by adding the following code, starting with the "Fill in the subtraction problem" comment.
104
+
1. Modify the `StartTheQuiz()` method in *Form1.cs* or *Form1.vb*by adding the following code, starting with the "Fill in the subtraction problem" comment.
2. In **Windows Forms Designer**, move a <xref:System.Windows.Forms.Timer> control from the **Components** category of the **Toolbox** to your form. The control appears in the gray area at the bottom of the design window.
48
46
49
47
3. On the form, select the **timer1** icon that you just added, and set its **Interval** property to **1000**. Because this interval is in milliseconds, a value of 1000 causes the timer to raise a <xref:System.Windows.Forms.Timer.Tick> event every second.
- The first line declares the method. It includes a parameter that's named `sender`. In C#, the parameter is `object sender`. In Visual Basic, it's `sender As System.Object`. This parameter refers to the object whose event is firing, which is known as the sender. In this case, the sender object is the NumericUpDown control.
![learn-build-service-prod[bot]](https://avatars.githubusercontent.com/in/237442?v=4&size=40){kind=avatar}
0 commit comments