Share via


ConfigurationHelperService Class

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

This API is not CLS-compliant. 

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Shell.Design.Serialization.ConfigurationHelperService

Namespace:  Microsoft.VisualStudio.Shell.Design.Serialization
Assembly:  Microsoft.VisualStudio.Shell.Design (in Microsoft.VisualStudio.Shell.Design.dll)

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public Class ConfigurationHelperService
[CLSCompliantAttribute(false)]
public class ConfigurationHelperService
[CLSCompliantAttribute(false)]
public ref class ConfigurationHelperService
[<CLSCompliantAttribute(false)>]
type ConfigurationHelperService =  class end
public class ConfigurationHelperService

The ConfigurationHelperService type exposes the following members.

Constructors

  Name Description
Public method ConfigurationHelperService() Initializes a new instance of ConfigurationHelperService.
Public method ConfigurationHelperService(Func<String, String>)

Top

Methods

  Name Description
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetSectionName Formats the group name and the key name.
Public method GetSerializeAs Determines the default serialization mechanism to use for a given type,.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GetUserConfigurationPath Gets the most likely path to user configuration files for the current project, based on the values of different project properties.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ReadConnectionStrings Returns all the connection strings in the specified configuration that start with the specified prefix.
Public method ReadSettings Reads settings from the appropriate section.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method WriteConnectionStrings Writes the connection strings to the specified configuration file after deleting any existing connection strings with the specified prefix.
Public method WriteSettings Writes settings to the appropriate section after clearing existing settings.

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.VisualStudio.Shell.Design.Serialization Namespace