Skip to content

Update WinForms link URLs #11398

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 5, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 50 additions & 50 deletions xml/Microsoft.VisualBasic.Compatibility.VB6/DirListBox.xml

Large diffs are not rendered by default.

88 changes: 44 additions & 44 deletions xml/Microsoft.VisualBasic.Compatibility.VB6/DriveListBox.xml

Large diffs are not rendered by default.

96 changes: 48 additions & 48 deletions xml/Microsoft.VisualBasic.Compatibility.VB6/FileListBox.xml

Large diffs are not rendered by default.

1,148 changes: 574 additions & 574 deletions xml/Microsoft.VisualBasic.Compatibility.VB6/Support.xml

Large diffs are not rendered by default.

556 changes: 278 additions & 278 deletions xml/Microsoft.VisualBasic.Devices/Ports.xml

Large diffs are not rendered by default.

1,218 changes: 609 additions & 609 deletions xml/Microsoft.VisualBasic.MyServices/ClipboardProxy.xml

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
<altmember cref="T:System.Configuration.ApplicationSettingsBase" />
<altmember cref="T:System.Configuration.SettingsProvider" />
<altmember cref="T:System.Configuration.ConfigurationErrorsException" />
<related type="Article" href="/dotnet/framework/winforms/advanced/application-settings-architecture">Application Settings Architecture</related>
<related type="Article" href="/dotnet/desktop/winforms/advanced/application-settings-architecture">Application Settings Architecture</related>
</Docs>
<Members>
<Member MemberName=".ctor">
Expand Down
570 changes: 285 additions & 285 deletions xml/System.Configuration/ApplicationSettingsBase.xml

Large diffs are not rendered by default.

40 changes: 20 additions & 20 deletions xml/System.Configuration/ClientSettingsSection.xml
Original file line number Diff line number Diff line change
Expand Up @@ -33,21 +33,21 @@
<Docs>
<summary>Represents a group of user-scoped application settings in a configuration file.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The .NET Framework contains a single default settings provider, <xref:System.Configuration.LocalFileSettingsProvider>, which stores configuration data to the local file system in files with the extension `.config`. The contents of configuration files are structured as XML documents. User-scoped settings are persisted in a file with the name `username.config`. Within this file, data is stored as elements within a `<userSettings>` section. Each of these sections is represented by a corresponding <xref:System.Configuration.ClientSettingsSection>. Each section object is owned and administered by a configuration section handler, which is an <xref:System.Configuration.IConfigurationSectionHandler>.
The <xref:System.Configuration.ClientSettingsSection> class represents a simple extension of the <xref:System.Configuration.ConfigurationSection> class, which is used in the .NET Framework support for general configuration files.
For more information about application settings, see the topic [Application Settings for Windows Forms](/dotnet/framework/winforms/advanced/application-settings-for-windows-forms).
<format type="text/markdown"><![CDATA[

## Remarks
The .NET Framework contains a single default settings provider, <xref:System.Configuration.LocalFileSettingsProvider>, which stores configuration data to the local file system in files with the extension `.config`. The contents of configuration files are structured as XML documents. User-scoped settings are persisted in a file with the name `username.config`. Within this file, data is stored as elements within a `<userSettings>` section. Each of these sections is represented by a corresponding <xref:System.Configuration.ClientSettingsSection>. Each section object is owned and administered by a configuration section handler, which is an <xref:System.Configuration.IConfigurationSectionHandler>.

The <xref:System.Configuration.ClientSettingsSection> class represents a simple extension of the <xref:System.Configuration.ConfigurationSection> class, which is used in the .NET Framework support for general configuration files.

For more information about application settings, see the topic [Application Settings for Windows Forms](/dotnet/desktop/winforms/advanced/application-settings-for-windows-forms).

]]></format>
</remarks>
<altmember cref="T:System.Configuration.LocalFileSettingsProvider" />
<altmember cref="T:System.Configuration.AppSettingsSection" />
<altmember cref="T:System.Configuration.IConfigurationSectionHandler" />
<related type="Article" href="/dotnet/framework/winforms/advanced/application-settings-for-windows-forms">Application Settings for Windows Forms</related>
<related type="Article" href="/dotnet/desktop/winforms/advanced/application-settings-for-windows-forms">Application Settings for Windows Forms</related>
</Docs>
<Members>
<Member MemberName=".ctor">
Expand Down Expand Up @@ -83,11 +83,11 @@
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Configuration.ClientSettingsSection" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The default <xref:System.Configuration.ClientSettingsSection.%23ctor%2A> constructor initializes the <xref:System.Configuration.ClientSettingsSection.Settings%2A> property.
<format type="text/markdown"><![CDATA[

## Remarks
The default <xref:System.Configuration.ClientSettingsSection.%23ctor%2A> constructor initializes the <xref:System.Configuration.ClientSettingsSection.Settings%2A> property.

]]></format>
</remarks>
<altmember cref="P:System.Configuration.ClientSettingsSection.Settings" />
Expand Down Expand Up @@ -172,11 +172,11 @@
<summary>Gets the collection of client settings for the section.</summary>
<value>A <see cref="T:System.Configuration.SettingElementCollection" /> containing all the client settings found in the current configuration section.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Configuration.ClientSettingsSection.Settings%2A> property is itself a configuration property.
<format type="text/markdown"><![CDATA[

## Remarks
The <xref:System.Configuration.ClientSettingsSection.Settings%2A> property is itself a configuration property.

]]></format>
</remarks>
<altmember cref="T:System.Configuration.ConfigurationPropertyAttribute" />
Expand Down
72 changes: 36 additions & 36 deletions xml/System.Configuration/DefaultSettingValueAttribute.xml
Original file line number Diff line number Diff line change
Expand Up @@ -38,37 +38,37 @@
<Docs>
<summary>Specifies the default value for an application settings property.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
<format type="text/markdown"><![CDATA[

## Remarks

> [!IMPORTANT]
> <xref:System.Configuration.DefaultSettingValueAttribute> can only be applied to individual settings properties; it is invalid to apply this attribute to an entire application settings class.
Different settings providers may have different requirements or limitations on the use of the <xref:System.Configuration.DefaultSettingValueAttribute>. For example, the <xref:System.Configuration.LocalFileSettingsProvider> does not require this attribute, and will override any value provided by this attribute if there are any values - default or user-modified - already present in the data store.
<xref:System.Configuration.DefaultSettingValueAttribute> requires that the default value can be represented as a string. As a result, settings using XML serialization cannot have a default value specified by means of this attribute. Some providers may choose to support multiple serialization schemes which can be specified at compile time using the <xref:System.Configuration.SettingsSerializeAsAttribute>.
> <xref:System.Configuration.DefaultSettingValueAttribute> can only be applied to individual settings properties; it is invalid to apply this attribute to an entire application settings class.

Different settings providers may have different requirements or limitations on the use of the <xref:System.Configuration.DefaultSettingValueAttribute>. For example, the <xref:System.Configuration.LocalFileSettingsProvider> does not require this attribute, and will override any value provided by this attribute if there are any values - default or user-modified - already present in the data store.

<xref:System.Configuration.DefaultSettingValueAttribute> requires that the default value can be represented as a string. As a result, settings using XML serialization cannot have a default value specified by means of this attribute. Some providers may choose to support multiple serialization schemes which can be specified at compile time using the <xref:System.Configuration.SettingsSerializeAsAttribute>.

> [!CAUTION]
> The default values specified by this attribute are stored as plain text in the resultant compiled .exe or .dll file. Therefore these default values are inherently insecure.
## Examples
The following code example demonstrates the use of the <xref:System.Configuration.DefaultSettingValueAttribute> applied to three of the four properties of the `FormSettings` wrapper class, which is derived from the <xref:System.Configuration.ApplicationSettingsBase> class. This class is used to persist the location, size, background color, and text of form. The first three of these form properties have default values associated with them.
The full code example is listed in the <xref:System.Configuration.ApplicationSettingsBase> class overview.
> The default values specified by this attribute are stored as plain text in the resultant compiled .exe or .dll file. Therefore these default values are inherently insecure.



## Examples
The following code example demonstrates the use of the <xref:System.Configuration.DefaultSettingValueAttribute> applied to three of the four properties of the `FormSettings` wrapper class, which is derived from the <xref:System.Configuration.ApplicationSettingsBase> class. This class is used to persist the location, size, background color, and text of form. The first three of these form properties have default values associated with them.

The full code example is listed in the <xref:System.Configuration.ApplicationSettingsBase> class overview.

:::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/AppSettingsSample/cpp/AppSettingsSample.cpp" id="Snippet9":::
:::code language="csharp" source="~/snippets/csharp/System.Configuration/ApplicationSettingsBase/Overview/AppSettingsSample.cs" id="Snippet9":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/AppSettingsSample/VB/Form1.vb" id="Snippet9":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/AppSettingsSample/VB/Form1.vb" id="Snippet9":::

]]></format>
</remarks>
<altmember cref="T:System.Configuration.SettingsProvider" />
<altmember cref="T:System.Configuration.LocalFileSettingsProvider" />
<altmember cref="T:System.Configuration.SettingsSerializeAsAttribute" />
<related type="Article" href="/dotnet/framework/winforms/advanced/application-settings-for-windows-forms">Application Settings for Windows Forms</related>
<related type="Article" href="/dotnet/desktop/winforms/advanced/application-settings-for-windows-forms">Application Settings for Windows Forms</related>
</Docs>
<Members>
<Member MemberName=".ctor">
Expand Down Expand Up @@ -108,14 +108,14 @@
<param name="value">A <see cref="T:System.String" /> that represents the default value for the property.</param>
<summary>Initializes an instance of the <see cref="T:System.Configuration.DefaultSettingValueAttribute" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The supplied string must be a value that is compatible with the available serialization mechanism associated with the property type. For example, if the property is of type <xref:System.Drawing.Color>, then a `value` of `"Azure"` would be valid.
<format type="text/markdown"><![CDATA[

## Remarks
The supplied string must be a value that is compatible with the available serialization mechanism associated with the property type. For example, if the property is of type <xref:System.Drawing.Color>, then a `value` of `"Azure"` would be valid.

> [!CAUTION]
> The default values specified by this attribute are stored as plain text in the resultant compiled .exe or .dll file. Therefore these default values are inherently insecure.
> The default values specified by this attribute are stored as plain text in the resultant compiled .exe or .dll file. Therefore these default values are inherently insecure.

]]></format>
</remarks>
<altmember cref="P:System.Configuration.DefaultSettingValueAttribute.Value" />
Expand Down Expand Up @@ -159,13 +159,13 @@
<summary>Gets the default value for the application settings property.</summary>
<value>A <see cref="T:System.String" /> that represents the default value for the property.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Configuration.DefaultSettingValueAttribute.Value%2A> property is set in the <xref:System.Configuration.DefaultSettingValueAttribute.%23ctor%2A> constructor.
Setting providers may support multiple serialization schemes that can be specified with the <xref:System.Configuration.SettingsSerializeAsAttribute>.
<format type="text/markdown"><![CDATA[

## Remarks
The <xref:System.Configuration.DefaultSettingValueAttribute.Value%2A> property is set in the <xref:System.Configuration.DefaultSettingValueAttribute.%23ctor%2A> constructor.

Setting providers may support multiple serialization schemes that can be specified with the <xref:System.Configuration.SettingsSerializeAsAttribute>.

]]></format>
</remarks>
<altmember cref="T:System.Configuration.SettingsSerializeAsAttribute" />
Expand Down
Loading