Share via

ConfigurationHelperService Class

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Shell.Design.Serialization
Assembly:
Microsoft.VisualStudio.Shell.Design.dll
Package:
Microsoft.VisualStudio.Shell.Design v17.12.40392

Important

This API is not CLS-compliant.

A service used by the settings UI in Visual Studio to read and write client settings into the app.config configuration file. It stores user-customizable settings in XML format

public ref class ConfigurationHelperService
[Windows::Foundation::Metadata::WebHostHidden]
class ConfigurationHelperService
[System.CLSCompliant(false)]
public class ConfigurationHelperService
public class ConfigurationHelperService
[<System.CLSCompliant(false)>]
type ConfigurationHelperService = class
type ConfigurationHelperService = class
Public Class ConfigurationHelperService
Inheritance
Object
ConfigurationHelperService
Attributes
CLSCompliantAttribute

Constructors

ConfigurationHelperService()

Initializes a new instance of ConfigurationHelperService.
ConfigurationHelperService(Func<String,String>)

Initializes a new instance of ConfigurationHelperService.

Methods

GetSectionName(String, String)

Formats the group name and the key name.
GetSerializeAs(Type)

Determines the default serialization mechanism to use for a given type,.
GetUserConfigurationPath(IServiceProvider, Project, ConfigurationUserLevel, Boolean, Configuration)

Gets the most likely path to user configuration files for the current project, based on the values of different project properties.
ReadConnectionStrings(String, DocData, String)

Returns all the connection strings in the specified configuration that start with the specified prefix.
ReadSettings(ExeConfigurationFileMap, ConfigurationUserLevel, DocData, String, Boolean, SettingsPropertyCollection)

Reads settings from the appropriate section.
WriteConnectionStrings(String, DocData, String, ConnectionStringSettingsCollection)

Writes the connection strings to the specified configuration file after deleting any existing connection strings with the specified prefix.
WriteSettings(ExeConfigurationFileMap, ConfigurationUserLevel, DocData, String, Boolean, SettingsPropertyValueCollection)

Writes settings to the appropriate section after clearing existing settings.

Applies to