Edit

LocalFileSettingsProvider.SetPropertyValues Method

  • Reference

Definition

Namespace:
System.Configuration
Assembly:
System.Configuration.ConfigurationManager.dll
Assembly:
System.dll
Package:
System.Configuration.ConfigurationManager v6.0.0
Package:
System.Configuration.ConfigurationManager v7.0.0
Package:
System.Configuration.ConfigurationManager v8.0.0
Package:
System.Configuration.ConfigurationManager v9.0.0-preview.2.24128.5
Source:
LocalFileSettingsProvider.cs
Source:
LocalFileSettingsProvider.cs
Source:
LocalFileSettingsProvider.cs

Sets the values of the specified group of property settings.

public:
 override void SetPropertyValues(System::Configuration::SettingsContext ^ context, System::Configuration::SettingsPropertyValueCollection ^ values);
public override void SetPropertyValues (System.Configuration.SettingsContext context, System.Configuration.SettingsPropertyValueCollection values);
override this.SetPropertyValues : System.Configuration.SettingsContext * System.Configuration.SettingsPropertyValueCollection -> unit
Public Overrides Sub SetPropertyValues (context As SettingsContext, values As SettingsPropertyValueCollection)

Parameters

context
SettingsContext

A SettingsContext describing the current application usage.

values
SettingsPropertyValueCollection

A SettingsPropertyValueCollection representing the group of property settings to set.

Exceptions

ConfigurationErrorsException

A user-scoped setting was encountered but the current configuration only supports application-scoped settings.

-or-

There was a general failure saving the settings to the configuration file.

Remarks

A settings wrapper class, derived from ApplicationSettingsBase, contains the Save method, which is called to persist the values of all of its settings properties. This method enumerates through all the settings providers associated with its settings properties, and calls the SetPropertyValues method for each SettingsProvider to perform the actual serialization operation.

SetPropertyValues individually serializes each user-scoped application settings property to its corresponding application setting in the appropriate user.config configuration file.

By default, the SetPropertyValues method uses the following logical sequence to determine the serialization scheme, depending on type of the settings property:

  1. If the type has an associated TypeConverter with a ConvertToString method implementation, this conversion is used.

  2. XML serialization is used.

However, you can specify a preferred serialization mechanism by using the SettingsSerializeAsAttribute. LocalFileSettingsProvider does not support binary serialization in Visual Studio 2005.

If a user-scoped settings property is set back to its default value explicitly, then the local file settings provider will remove the entry for the associated setting from the user configuration file. The next read access for this property will simply use the default value.

Caution

LocalFileSettingsProvider does not use encryption to persist any settings. Therefore, do not store plain text passwords or other sensitive information using this provider without taking additional precautions, such as separately encrypting the information within the configuration file. For more information, see Encrypting Configuration Information Using Protected Configuration.

Applies to

See also