mscorlib(4.0.0.0) API with additions
System.Configuration Namespace Reference

Classes

class  ApplicationScopedSettingAttribute
 Specifies that an application settings property has a common value for all users of an application. This class cannot be inherited. More...
 
class  ApplicationSettingsBase
 Acts as a base class for deriving concrete wrapper classes to implement the application settings feature in Window Forms applications. More...
 
class  ApplicationSettingsGroup
 Represents a grouping of related application settings sections within a configuration file. This class cannot be inherited. More...
 
class  AppSettingsReader
 Provides a method for reading values of a particular type from the configuration. More...
 
class  ClientSettingsSection
 Represents a group of user-scoped application settings in a configuration file. More...
 
class  ConfigurationException
 The exception that is thrown when a configuration system error has occurred. More...
 
class  ConfigurationSettings
 Provides runtime versions 1.0 and 1.1 support for reading configuration sections and common configuration settings. More...
 
class  ConfigXmlDocument
 Wraps the corresponding T:System.Xml.XmlDocument type and also carries the necessary information for reporting file-name and line numbers. More...
 
class  DefaultSettingValueAttribute
 Specifies the default value for an application settings property. More...
 
class  DictionarySectionHandler
 Provides key/value pair configuration information from a configuration section. More...
 
interface  IApplicationSettingsProvider
 Defines extended capabilities for client-based application settings providers. More...
 
interface  IConfigurationSectionHandler
 Handles the access to certain configuration sections. More...
 
interface  IConfigurationSystem
 Provides standard configuration methods. More...
 
class  IdnElement
 Provides the configuration setting for International Domain Name (IDN) processing in the T:System.Uri class. More...
 
class  IgnoreSectionHandler
 Provides a legacy section-handler definition for configuration sections that are not handled by the N:System.Configuration types. More...
 
interface  IPersistComponentSettings
 Defines standard functionality for controls or libraries that store and retrieve application settings. More...
 
class  IriParsingElement
 Provides the configuration setting for International Resource Identifier (IRI) processing in the T:System.Uri class. More...
 
interface  ISettingsProviderService
 Provides an interface for defining an alternate application settings provider. More...
 
class  LocalFileSettingsProvider
 Provides persistence for application settings classes. More...
 
class  NameValueFileSectionHandler
 Provides access to a configuration file. This type supports the .NET Framework configuration infrastructure and is not intended to be used directly from your code. More...
 
class  NameValueSectionHandler
 Provides name/value-pair configuration information from a configuration section. More...
 
class  NoSettingsVersionUpgradeAttribute
 Specifies that a settings provider should disable any logic that gets invoked when an application upgrade is detected. This class cannot be inherited. More...
 
class  SchemeSettingElement
 Represents an element in a T:System.Configuration.SchemeSettingElementCollection class. More...
 
class  SchemeSettingElementCollection
 Represents a collection of T:System.Configuration.SchemeSettingElement objects. More...
 
class  SettingAttribute
 Represents a custom settings attribute used to associate settings information with a settings property. More...
 
class  SettingChangingEventArgs
 Provides data for the E:System.Configuration.ApplicationSettingsBase.SettingChanging event. More...
 
class  SettingElement
 Represents a simplified configuration element used for updating elements in the configuration. This class cannot be inherited. More...
 
class  SettingElementCollection
 Contains a collection of T:System.Configuration.SettingElement objects. This class cannot be inherited. More...
 
class  SettingsAttributeDictionary
 Represents a collection of key/value pairs used to describe a configuration object as well as a T:System.Configuration.SettingsProperty object. More...
 
class  SettingsBase
 Provides the base class used to support user property settings. More...
 
class  SettingsContext
 Provides contextual information that the provider can use when persisting settings. More...
 
class  SettingsDescriptionAttribute
 Provides a string that describes an individual configuration property. This class cannot be inherited. More...
 
class  SettingsGroupDescriptionAttribute
 Provides a string that describes an application settings property group. This class cannot be inherited. More...
 
class  SettingsGroupNameAttribute
 Specifies a name for application settings property group. This class cannot be inherited. More...
 
class  SettingsLoadedEventArgs
 Provides data for the E:System.Configuration.ApplicationSettingsBase.SettingsLoaded event. More...
 
class  SettingsManageabilityAttribute
 Specifies special services for application settings properties. This class cannot be inherited. More...
 
class  SettingsProperty
 Used internally as the class that represents metadata about an individual configuration property. More...
 
class  SettingsPropertyCollection
 Contains a collection of T:System.Configuration.SettingsProperty objects. More...
 
class  SettingsPropertyIsReadOnlyException
 Provides an exception for read-only T:System.Configuration.SettingsProperty objects. More...
 
class  SettingsPropertyNotFoundException
 Provides an exception for T:System.Configuration.SettingsProperty objects that are not found. More...
 
class  SettingsPropertyValue
 Contains the value of a settings property that can be loaded and stored by an instance of T:System.Configuration.SettingsBase. More...
 
class  SettingsPropertyValueCollection
 Contains a collection of settings property values that map T:System.Configuration.SettingsProperty objects to T:System.Configuration.SettingsPropertyValue objects. More...
 
class  SettingsPropertyWrongTypeException
 Provides an exception that is thrown when an invalid type is used with a T:System.Configuration.SettingsProperty object. More...
 
class  SettingsProvider
 Acts as a base class for deriving custom settings providers in the application settings architecture. More...
 
class  SettingsProviderAttribute
 Specifies the settings provider used to provide storage for the current application settings class or property. This class cannot be inherited. More...
 
class  SettingsProviderCollection
 Represents a collection of application settings providers. More...
 
class  SettingsSerializeAsAttribute
 Specifies the serialization mechanism that the settings provider should use. This class cannot be inherited. More...
 
class  SettingValueElement
 Contains the XML representing the serialized value of the setting. This class cannot be inherited. More...
 
class  SingleTagSectionHandler
 Handles configuration sections that are represented by a single XML tag in the .config file. More...
 
class  SpecialSettingAttribute
 Indicates that an application settings property has a special significance. This class cannot be inherited. More...
 
class  UriSection
 Represents the Uri section within a configuration file. More...
 
class  UserScopedSettingAttribute
 Specifies that an application settings group or property contains distinct values for each user of an application. This class cannot be inherited. More...
 
class  UserSettingsGroup
 Represents a grouping of related user settings sections within a configuration file. This class cannot be inherited. More...
 

Enumerations

enum  SettingsManageability { SettingsManageability.Roaming }
 Provides values to indicate which services should be made available to application settings. More...
 
enum  SettingsSerializeAs { SettingsSerializeAs.String, SettingsSerializeAs.Xml, SettingsSerializeAs.Binary, SettingsSerializeAs.ProviderSpecific }
 Determines the serialization scheme used to store application settings. More...
 
enum  SpecialSetting { SpecialSetting.ConnectionString, SpecialSetting.WebServiceUrl }
 Specifies the special setting category of a application settings property. More...
 

Functions

delegate void SettingChangingEventHandler (object sender, SettingChangingEventArgs e)
 Represents the method that will handle the E:System.Configuration.ApplicationSettingsBase.SettingChanging event. More...
 
delegate void SettingsLoadedEventHandler (object sender, SettingsLoadedEventArgs e)
 Represents the method that will handle the E:System.Configuration.ApplicationSettingsBase.SettingsLoaded event. More...
 
delegate void SettingsSavingEventHandler (object sender, CancelEventArgs e)
 Represents the method that will handle the E:System.Configuration.ApplicationSettingsBase.SettingsSaving event. More...
 

Enumeration Type Documentation

◆ SettingsManageability

Provides values to indicate which services should be made available to application settings.

Enumerator
Roaming 

Enables application settings to be stored in roaming user profiles. For more information about roaming user profiles, see Isolated Storage and Roaming.

Definition at line 4 of file SettingsManageability.cs.

◆ SettingsSerializeAs

Determines the serialization scheme used to store application settings.

Enumerator
String 

The settings property is serialized as plain text.

Xml 

The settings property is serialized as XML using XML serialization.

Binary 

The settings property is serialized using binary object serialization.

ProviderSpecific 

The settings provider has implicit knowledge of the property or its type and picks an appropriate serialization mechanism. Often used for custom serialization.

Definition at line 4 of file SettingsSerializeAs.cs.

◆ SpecialSetting

Specifies the special setting category of a application settings property.

Enumerator
ConnectionString 

The configuration property represents a connection string, typically for a data store or network resource.

WebServiceUrl 

The configuration property represents a Uniform Resource Locator (URL) to a Web service.

Definition at line 4 of file SpecialSetting.cs.

Function Documentation

◆ SettingChangingEventHandler()

delegate void System.Configuration.SettingChangingEventHandler ( object  sender,
SettingChangingEventArgs  e 
)

Represents the method that will handle the E:System.Configuration.ApplicationSettingsBase.SettingChanging event.

Parameters
senderThe source of the event, typically an application settings wrapper class derived from the T:System.Configuration.ApplicationSettingsBase class.
eA T:System.Configuration.SettingChangingEventArgs containing the data for the event.

◆ SettingsLoadedEventHandler()

delegate void System.Configuration.SettingsLoadedEventHandler ( object  sender,
SettingsLoadedEventArgs  e 
)

Represents the method that will handle the E:System.Configuration.ApplicationSettingsBase.SettingsLoaded event.

Parameters
senderThe source of the event, typically the settings class.
eA T:System.Configuration.SettingsLoadedEventArgs object that contains the event data.

◆ SettingsSavingEventHandler()

delegate void System.Configuration.SettingsSavingEventHandler ( object  sender,
CancelEventArgs  e 
)

Represents the method that will handle the E:System.Configuration.ApplicationSettingsBase.SettingsSaving event.

Parameters
senderThe source of the event, typically a data container or data-bound collection.
eA T:System.ComponentModel.CancelEventArgs that contains the event data.