System.Configuration - API Reference

<PackageReference Include="System.Configuration.ConfigurationManager" Version="7.0.0-rc.1.22426.10" />

System.Configuration

Namespace with 143 public types

Classes

ApplicationScopedSettingAttribute Indicates that a setting is to be stored on a per-application basis.

ApplicationSettingsGroup

AppSettingsReader The AppSettingsReader class provides a wrapper for System.Configuration.ConfigurationManager.AppSettings which provides a single method for reading values from the config file of a particular type.

AppSettingsSection

CallbackValidator

CallbackValidatorAttribute

ClientSettingsSection ConfigurationSection class for sections that store client settings.

CommaDelimitedStringCollection

CommaDelimitedStringCollectionConverter

ConfigurationCollectionAttribute Used on classes derived from ConfigurationElementCollection. Specifies the collection item type and verbs used for add/remove/clear.

ConfigurationElementProperty

ConfigurationErrorsException

ConfigurationException A config exception can contain a filename (of a config file) and a line number (of the location in the file in which a problem was encountered). Section handlers should throw this exception (or subclasses) together with filename and line number information where possible.

ConfigurationFileMap Holds the configuration file mapping for machine.config. It is the base class for ExeConfigurationFileMap and WebConfigurationFileMap.

ConfigurationLocation

ConfigurationLocationCollection

ConfigurationLockCollection

ConfigurationProperty

ConfigurationPropertyAttribute

ConfigurationPropertyCollection

ConfigurationSectionCollection

ConfigurationSectionGroup

ConfigurationSectionGroupCollection

ConfigurationSettings

ConfigurationValidatorAttribute

ConfigXmlDocument

ConnectionStringSettings

ConnectionStringSettingsCollection

ConnectionStringsSection

ContextInformation

DefaultSettingValueAttribute Indicates to the provider what default value to use for this setting when no stored value is found. The value should be encoded into a string and is interpreted based on the SerializeAs value for this setting. For example, if SerializeAs is Xml, the default value will be "stringified" Xml.

DefaultValidator

DictionarySectionHandler Simple dictionary config factory config is a dictionary mapping key->value <add key="name" value="text"> sets key=text <remove key="name"> removes the definition of key <clear> removes all definitions

DpapiProtectedConfigurationProvider

ElementInformation

ExeConfigurationFileMap

GenericEnumConverter

IgnoreSectionHandler

InfiniteIntConverter

InfiniteTimeSpanConverter

IntegerValidator

IntegerValidatorAttribute

IriParsingElement

KeyValueConfigurationCollection

KeyValueConfigurationElement

LocalFileSettingsProvider This is a provider used to store configuration settings locally for client applications.

LongValidatorAttribute

NameValueConfigurationCollection

NameValueConfigurationElement

NameValueFileSectionHandler This section handler allows <appSettings file="user.config" /> The file pointed to by the file= attribute is read as if it is an appSettings section in the config file. Note: the user.config file must have its root element match the section referring to it. So if appSettings has a file="user.config" attribute the root element in user.config must also be named appSettings.

NameValueSectionHandler Simple dictionary config factory

NoSettingsVersionUpgradeAttribute Indicates that the provider should disable any logic that gets invoked when an application upgrade is detected.

PositiveTimeSpanValidator

PositiveTimeSpanValidatorAttribute

PropertyInformation

PropertyInformationCollection

ProtectedConfigurationProviderCollection

ProtectedConfigurationSection

ProtectedProviderSettings

ProviderSettings

ProviderSettingsCollection

RegexStringValidator

RegexStringValidatorAttribute

RsaProtectedConfigurationProvider

SchemeSettingElement

SchemeSettingElementCollection

SectionInformation

SettingAttribute Use this attribute to mark properties on a settings class that are to be treated as settings. ApplicationSettingsBase will ignore all properties not marked with this or a derived attribute.

SettingChangingEventArgs Event args for the SettingChanging event.

SettingElementCollection

SettingsAttributeDictionary

SettingsContext

SettingsDescriptionAttribute Description for a particular setting.

SettingsGroupDescriptionAttribute Description for a particular settings group.

SettingsGroupNameAttribute Name of a particular settings group.

SettingsLoadedEventArgs Event args for the SettingLoaded event.

SettingsManageabilityAttribute Indicates the SettingsManageability for a group of/individual setting.

SettingsProperty

SettingsPropertyCollection

SettingsPropertyIsReadOnlyException

SettingsPropertyNotFoundException

SettingsPropertyValue

SettingsPropertyValueCollection

SettingsPropertyWrongTypeException

SettingsProviderAttribute Indicates the provider associated with a group of/individual setting.

SettingsProviderCollection

SettingsSerializeAsAttribute Indicates the SettingsSerializeAs for a group of/individual setting.

SettingValueElement

SingleTagSectionHandler

SpecialSettingAttribute Indicates the SpecialSetting for a group of/individual settings.

StringValidator

StringValidatorAttribute

SubclassTypeValidator

SubclassTypeValidatorAttribute

TimeSpanMinutesConverter

TimeSpanMinutesOrInfiniteConverter

TimeSpanSecondsConverter

TimeSpanSecondsOrInfiniteConverter

TimeSpanValidator

TimeSpanValidatorAttribute

TypeNameConverter

UserScopedSettingAttribute Indicates that a setting is to be stored on a per-user basis.

UserSettingsGroup

WhiteSpaceTrimStringConverter

Enumerations

ConfigurationAllowDefinition

ConfigurationAllowExeDefinition

ConfigurationElementCollectionType

ConfigurationPropertyOptions

ConfigurationSaveMode

ConfigurationUserLevel

PropertyValueOrigin

SettingsManageability

SettingsSerializeAs

SpecialSetting Indicates settings that are to be treated "specially".

Static Classes

ConfigurationManager

ProtectedConfiguration

Abstract Classes

ApplicationSettingsBase Base settings class for client applications.

ConfigurationConverterBase

ConfigurationElement

ConfigurationElementCollection

ConfigurationSection

ConfigurationValidatorBase

ProtectedConfigurationProvider

SettingsProvider

Interfaces

IApplicationSettingsProvider This interface is an extension to SettingsProvider that a provider can implement to support additional functionality for settings classes that derive from ApplicationSettingsBase.

IConfigurationSectionHandler The IConfigurationSectionHandler interface defines the contract that all configuration section handlers must implement in order to participate in the resolution of configuration settings. Composes and creates config objects. This interface is implemented by config providers. Classes implementing IConfigurationSectionHandler define the rules for cooking XML config into usable objects. The cooked objects can be of arbitrary type. Configuration is composable (e.g., config in a child directory is layered over config in a parent directory), so, IConfigurationSectionHandler is supplied with the parent config as well as any number of XML fragments.

IConfigurationSystem

IPersistComponentSettings Components should implement this interface if they want to persist custom settings in a hosting application. This interface allows the application author to tell a control whether to persist, when to load, save etc.

ISettingsProviderService The IPersistComponentSettings interface enables components hosted in an application to persist their settings in a manner transparent to the application. However, in some cases, the application may want to override the provider(s) specified by a component. For example, at design time, we may want to persist settings differently. This service enables this scenario. The ApplicationSettingsBase class queries this service from the owner component's site.