ConfigurationElement Class
Represents a configuration element within a configuration file.
Assembly: System.Configuration (in System.Configuration.dll)
System.Configuration.ConfigurationElement
System.Configuration.ConfigurationElementCollection
System.Configuration.ConfigurationSection
System.Configuration.ConnectionStringSettings
System.Configuration.IdnElement
System.Configuration.IriParsingElement
System.Configuration.KeyValueConfigurationElement
System.Configuration.NameValueConfigurationElement
System.Configuration.ProtectedProviderSettings
System.Configuration.ProviderSettings
System.Configuration.SchemeSettingElement
System.Configuration.SettingElement
System.Configuration.SettingValueElement
System.Data.Services.Configuration.DataServicesReplaceFunctionFeature
System.IdentityModel.Configuration.AudienceUriElement
System.IdentityModel.Configuration.ConfigurationElementInterceptor
System.IdentityModel.Configuration.IdentityConfigurationElement
System.IdentityModel.Configuration.IdentityModelCachesElement
System.IdentityModel.Configuration.SecurityTokenHandlerConfigurationElement
System.IdentityModel.Configuration.TokenReplayDetectionElement
System.IdentityModel.Configuration.X509CertificateValidationElement
System.IdentityModel.Services.ChunkedCookieHandlerElement
System.IdentityModel.Services.Configuration.FederationConfigurationElement
System.IdentityModel.Services.Configuration.WSFederationElement
System.IdentityModel.Services.CookieHandlerElement
System.IdentityModel.Services.ServiceCertificateElement
System.Net.Configuration.AuthenticationModuleElement
System.Net.Configuration.BypassElement
System.Net.Configuration.ConnectionManagementElement
System.Net.Configuration.FtpCachePolicyElement
System.Net.Configuration.HttpCachePolicyElement
System.Net.Configuration.HttpListenerElement
System.Net.Configuration.HttpListenerTimeoutsElement
System.Net.Configuration.HttpWebRequestElement
System.Net.Configuration.Ipv6Element
System.Net.Configuration.ModuleElement
System.Net.Configuration.PerformanceCountersElement
System.Net.Configuration.ProxyElement
System.Net.Configuration.ServicePointManagerElement
System.Net.Configuration.SmtpNetworkElement
System.Net.Configuration.SmtpSpecifiedPickupDirectoryElement
System.Net.Configuration.SocketElement
System.Net.Configuration.WebProxyScriptElement
System.Net.Configuration.WebRequestModuleElement
System.Net.Configuration.WebUtilityElement
System.Runtime.Caching.Configuration.MemoryCacheElement
System.Runtime.Serialization.Configuration.DeclaredTypeElement
System.Runtime.Serialization.Configuration.ParameterElement
System.Runtime.Serialization.Configuration.TypeElement
System.Security.Authentication.ExtendedProtection.Configuration.ExtendedProtectionPolicyElement
System.Security.Authentication.ExtendedProtection.Configuration.ServiceNameElement
System.ServiceModel.Activation.Configuration.SecurityIdentifierElement
System.ServiceModel.Activities.Configuration.ChannelSettingsElement
System.ServiceModel.Activities.Configuration.FactorySettingsElement
System.ServiceModel.Activities.Tracking.Configuration.TrackingConfigurationElement
System.ServiceModel.Configuration.AllowedAudienceUriElement
System.ServiceModel.Configuration.AuthorizationPolicyTypeElement
System.ServiceModel.Configuration.BaseAddressElement
System.ServiceModel.Configuration.BaseAddressPrefixFilterElement
System.ServiceModel.Configuration.BindingCollectionElement
System.ServiceModel.Configuration.CertificateElement
System.ServiceModel.Configuration.CertificateReferenceElement
System.ServiceModel.Configuration.ChannelEndpointElement
System.ServiceModel.Configuration.ClaimTypeElement
System.ServiceModel.Configuration.ComContractElement
System.ServiceModel.Configuration.ComMethodElement
System.ServiceModel.Configuration.ComPersistableTypeElement
System.ServiceModel.Configuration.ComUdtElement
System.ServiceModel.Configuration.DefaultPortElement
System.ServiceModel.Configuration.DelegatingHandlerElement
System.ServiceModel.Configuration.DnsElement
System.ServiceModel.Configuration.EndpointCollectionElement
System.ServiceModel.Configuration.EndToEndTracingElement
System.ServiceModel.Configuration.ExtensionElement
System.ServiceModel.Configuration.HostElement
System.ServiceModel.Configuration.HostTimeoutsElement
System.ServiceModel.Configuration.HttpDigestClientElement
System.ServiceModel.Configuration.HttpMessageHandlerFactoryElement
System.ServiceModel.Configuration.IdentityElement
System.ServiceModel.Configuration.IssuedTokenClientBehaviorsElement
System.ServiceModel.Configuration.IssuedTokenClientElement
System.ServiceModel.Configuration.IssuedTokenServiceElement
System.ServiceModel.Configuration.MessageLoggingElement
System.ServiceModel.Configuration.MetadataElement
System.ServiceModel.Configuration.PeerCredentialElement
System.ServiceModel.Configuration.PolicyImporterElement
System.ServiceModel.Configuration.ProtocolMappingElement
System.ServiceModel.Configuration.RsaElement
System.ServiceModel.Configuration.SecureConversationServiceElement
System.ServiceModel.Configuration.ServiceActivationElement
System.ServiceModel.Configuration.ServiceElement
System.ServiceModel.Configuration.ServiceEndpointElement
System.ServiceModel.Configuration.ServiceModelConfigurationElement
System.ServiceModel.Configuration.ServiceModelExtensionCollectionElement<TServiceModelExtensionElement>
System.ServiceModel.Configuration.ServicePrincipalNameElement
System.ServiceModel.Configuration.StandardEndpointElement
System.ServiceModel.Configuration.TransportConfigurationTypeElement
System.ServiceModel.Configuration.UserNameServiceElement
System.ServiceModel.Configuration.UserPrincipalNameElement
System.ServiceModel.Configuration.WindowsClientElement
System.ServiceModel.Configuration.WindowsServiceElement
System.ServiceModel.Configuration.WsdlImporterElement
System.ServiceModel.Configuration.X509CertificateTrustedIssuerElement
System.ServiceModel.Configuration.X509ClientCertificateAuthenticationElement
System.ServiceModel.Configuration.X509ClientCertificateCredentialsElement
System.ServiceModel.Configuration.X509DefaultServiceCertificateElement
System.ServiceModel.Configuration.X509InitiatorCertificateClientElement
System.ServiceModel.Configuration.X509InitiatorCertificateServiceElement
System.ServiceModel.Configuration.X509PeerCertificateAuthenticationElement
System.ServiceModel.Configuration.X509PeerCertificateElement
System.ServiceModel.Configuration.X509RecipientCertificateClientElement
System.ServiceModel.Configuration.X509RecipientCertificateServiceElement
System.ServiceModel.Configuration.X509ScopedServiceCertificateElement
System.ServiceModel.Configuration.X509ServiceCertificateAuthenticationElement
System.ServiceModel.Configuration.XmlElementElement
System.ServiceModel.Configuration.XPathMessageFilterElement
System.ServiceModel.Discovery.Configuration.ContractTypeNameElement
System.ServiceModel.Discovery.Configuration.DiscoveryClientSettingsElement
System.ServiceModel.Discovery.Configuration.FindCriteriaElement
System.ServiceModel.Discovery.Configuration.ScopeElement
System.ServiceModel.Discovery.Configuration.UdpTransportSettingsElement
System.ServiceModel.Routing.Configuration.BackupEndpointElement
System.ServiceModel.Routing.Configuration.FilterElement
System.ServiceModel.Routing.Configuration.FilterTableEntryElement
System.ServiceModel.Routing.Configuration.NamespaceElement
System.Web.Configuration.AssemblyInfo
System.Web.Configuration.AuthorizationRule
System.Web.Configuration.BufferModeSettings
System.Web.Configuration.BuildProvider
System.Web.Configuration.ClientTarget
System.Web.Configuration.CodeSubDirectory
System.Web.Configuration.Compiler
System.Web.Configuration.Converter
System.Web.Configuration.CustomError
System.Web.Configuration.EventMappingSettings
System.Web.Configuration.ExpressionBuilder
System.Web.Configuration.FolderLevelBuildProvider
System.Web.Configuration.FormsAuthenticationConfiguration
System.Web.Configuration.FormsAuthenticationCredentials
System.Web.Configuration.FormsAuthenticationUser
System.Web.Configuration.FullTrustAssembly
System.Web.Configuration.HttpHandlerAction
System.Web.Configuration.HttpModuleAction
System.Web.Configuration.IgnoreDeviceFilterElement
System.Web.Configuration.NamespaceInfo
System.Web.Configuration.OutputCacheProfile
System.Web.Configuration.PartialTrustVisibleAssembly
System.Web.Configuration.PassportAuthentication
System.Web.Configuration.ProfileGroupSettings
System.Web.Configuration.ProfilePropertySettings
System.Web.Configuration.ProfileSettings
System.Web.Configuration.ProtocolElement
System.Web.Configuration.RuleSettings
System.Web.Configuration.SqlCacheDependencyDatabase
System.Web.Configuration.TagMapInfo
System.Web.Configuration.TagPrefixInfo
System.Web.Configuration.TransformerInfo
System.Web.Configuration.TrustLevel
System.Web.Configuration.UrlMapping
System.Web.Configuration.WebPartsPersonalization
System.Web.Configuration.WebPartsPersonalizationAuthorization
System.Web.Mobile.DeviceFilterElement
System.Web.Services.Configuration.DiagnosticsElement
System.Web.Services.Configuration.ProtocolElement
System.Web.Services.Configuration.SoapEnvelopeProcessingElement
System.Web.Services.Configuration.SoapExtensionTypeElement
System.Web.Services.Configuration.TypeElement
System.Web.Services.Configuration.WsdlHelpGeneratorElement
System.Web.Services.Configuration.WsiProfilesElement
System.Web.UI.MobileControls.ControlElement
System.Web.UI.MobileControls.DeviceElement
System.Workflow.Runtime.Configuration.WorkflowRuntimeServiceElement
System.Xml.Serialization.Configuration.SchemaImporterExtensionElement
| Name | Description | |
|---|---|---|
![]() | ConfigurationElement() | Initializes a new instance of the ConfigurationElement class. |
| Name | Description | |
|---|---|---|
![]() | CurrentConfiguration | Gets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to. |
![]() | ElementInformation | Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. |
![]() | ElementProperty | Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself. |
![]() | EvaluationContext | Gets the ContextInformation object for the ConfigurationElement object. |
![]() | HasContext | |
![]() | Item[ConfigurationProperty] | Gets or sets a property or attribute of this configuration element. |
![]() | Item[String] | Gets or sets a property, attribute, or child element of this configuration element. |
![]() | LockAllAttributesExcept | Gets the collection of locked attributes. |
![]() | LockAllElementsExcept | Gets the collection of locked elements. |
![]() | LockAttributes | Gets the collection of locked attributes |
![]() | LockElements | Gets the collection of locked elements. |
![]() | LockItem | Gets or sets a value indicating whether the element is locked. |
![]() | Properties | Gets the collection of properties. |
| Name | Description | |
|---|---|---|
![]() | DeserializeElement(XmlReader, Boolean) | Reads XML from the configuration file. |
![]() | Equals(Object) | Compares the current ConfigurationElement instance to the specified object.(Overrides Object.Equals(Object).) |
![]() | Finalize() | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.) |
![]() | GetHashCode() | Gets a unique value representing the current ConfigurationElement instance.(Overrides Object.GetHashCode().) |
![]() | GetTransformedAssemblyString(String) | Returns the transformed version of the specified assembly name. |
![]() | GetTransformedTypeString(String) | Returns the transformed version of the specified type name. |
![]() | GetType() | |
![]() | Init() | Sets the ConfigurationElement object to its initial state. |
![]() | InitializeDefault() | Used to initialize a default set of values for the ConfigurationElement object. |
![]() | IsModified() | Indicates whether this configuration element has been modified since it was last saved or loaded, when implemented in a derived class. |
![]() | IsReadOnly() | Gets a value indicating whether the ConfigurationElement object is read-only. |
![]() | ListErrors(IList) | Adds the invalid-property errors in this ConfigurationElement object, and in all subelements, to the passed list. |
![]() | MemberwiseClone() | |
![]() | OnDeserializeUnrecognizedAttribute(String, String) | Gets a value indicating whether an unknown attribute is encountered during deserialization. |
![]() | OnDeserializeUnrecognizedElement(String, XmlReader) | Gets a value indicating whether an unknown element is encountered during deserialization. |
![]() | OnRequiredPropertyNotFound(String) | Throws an exception when a required property is not found. |
![]() | PostDeserialize() | Called after deserialization. |
![]() | PreSerialize(XmlWriter) | Called before serialization. |
![]() | Reset(ConfigurationElement) | Resets the internal state of the ConfigurationElement object, including the locks and the properties collections. |
![]() | ResetModified() | Resets the value of the IsModified method to false when implemented in a derived class. |
![]() | SerializeElement(XmlWriter, Boolean) | Writes the contents of this configuration element to the configuration file when implemented in a derived class. |
![]() | SerializeToXmlElement(XmlWriter, String) | Writes the outer tags of this configuration element to the configuration file when implemented in a derived class. |
![]() | SetPropertyValue(ConfigurationProperty, Object, Boolean) | Sets a property to the specified value. |
![]() | SetReadOnly() | Sets the IsReadOnly property for the ConfigurationElement object and all subelements. |
![]() | ToString() | Returns a string that represents the current object.(Inherited from Object.) |
![]() | Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode) | Modifies the ConfigurationElement object to remove all values that should not be saved. |
The ConfigurationElement is an abstract class that is used to represent an XML element in a configuration file (such as Web.config). An element in a configuration file can contain zero, one, or more child elements.
Because the ConfigurationElement class is defined as abstract, you cannot create an instance of it. You can only derive classes from it. The .NET Framework includes classes that derive from the ConfigurationElement class in order to represent standard XML configuration elements, such as ConfigurationSection. You can also extend the ConfigurationElement class to access custom configuration elements and sections. The example included later in this topic shows how to access custom configuration elements and sections by using custom classes that derive from ConfigurationElement.
You can also extend the standard configuration types such as ConfigurationElement, ConfigurationElementCollection, ConfigurationProperty, and ConfigurationSection. For more information, see the documentation for those classes.
For more information about how to access information in configuration files, see the ConfigurationManager class and the WebConfigurationManager class.
Notes to Inheritors:
Every ConfigurationElement object creates an internal ConfigurationPropertyCollection collection of ConfigurationProperty objects that represents either the element attributes or a collection of child elements.
Non-customizable information and functionality is contained by an ElementInformation object provided by the ElementInformation property.
You can use either a programmatic or a declarative (attributed) coding model to create a custom configuration element:
The programmatic model requires that for each element attribute, you create a property to get or set its value and add it to the internal property bag of the underlying ConfigurationElement base class. For an example of how to use this model, see the ConfigurationSection class.
The simpler declarative model, also called the attributed model, allows you to define an element attribute by using a property and then decorate it with attributes. These attributes instruct the ASP.NET configuration system about the property types and their default values. With this information, obtained through reflection, the ASP.NET configuration system creates the element property objects for you and performs the required initialization. The example shown later in this topic shows how to use this model.
The following code example shows how to implement a custom ConfigurationElement both as an individual element in a custom section and as a collection of elements in a custom section. The example consists of the following files:
An app.config file that contains a custom section that is named MyUrls. This section contains a simple element (it does not contain any other elements) and a collection of elements. The simple element is named simple and the collection is named urls.
A console application. The application reads the contents of the app.config file and writes the information to the console. It uses classes that derive from ConfigurationElement, ConfigurationElementCollection, and ConfigurationSection.
A class named UrlsSection that derives from the ConfigurationSection class. This class is used to access the MyUrls section in the configuration file.
A class named UrlsCollection that derives from the ConfigurationElementCollection class. This class is used to access the urls collection in the configuration file.
A class named UrlConfigElement that derives from the ConfigurationElement class. This class is used to access the simple element and the members of the urls collection in the configuration file.
To run the example, perform the following steps:
Create a solution that has a console application project and a class library project that is named ConfigurationElement.
Put the three class files in the class library project and put the other files in the console library project.
In both projects set a reference to System.Configuration.
In the console application project set a project reference to the class library project.
// Set Assembly name to ConfigurationElement using System; using System.Configuration; using System.Collections; namespace Samples.AspNet { // Entry point for console application that reads the // app.config file and writes to the console the // URLs in the custom section. class TestConfigurationElement { static void Main(string[] args) { // Get current configuration file. System.Configuration.Configuration config = ConfigurationManager.OpenExeConfiguration( ConfigurationUserLevel.None); // Get the MyUrls section. UrlsSection myUrlsSection = config.GetSection("MyUrls") as UrlsSection; if (myUrlsSection == null) Console.WriteLine("Failed to load UrlsSection."); else { Console.WriteLine("The 'simple' element of app.config:"); Console.WriteLine(" Name={0} URL={1} Port={2}", myUrlsSection.Simple.Name, myUrlsSection.Simple.Url, myUrlsSection.Simple.Port); Console.WriteLine("The urls collection of app.config:"); for (int i = 0; i < myUrlsSection.Urls.Count; i++) { Console.WriteLine(" Name={0} URL={1} Port={2}", myUrlsSection.Urls[i].Name, myUrlsSection.Urls[i].Url, myUrlsSection.Urls[i].Port); } } Console.ReadLine(); } } }
using System; using System.Configuration; using System.Collections; namespace Samples.AspNet { // Define a custom section containing an individual // element and a collection of elements. public class UrlsSection : ConfigurationSection { [ConfigurationProperty("name", DefaultValue = "MyFavorites", IsRequired = true, IsKey = false)] [StringValidator(InvalidCharacters = " ~!@#$%^&*()[]{}/;'\"|\\", MinLength = 1, MaxLength = 60)] public string Name { get { return (string)this["name"]; } set { this["name"] = value; } } // Declare an element (not in a collection) of the type // UrlConfigElement. In the configuration // file it corresponds to <simple .... />. [ConfigurationProperty("simple")] public UrlConfigElement Simple { get { UrlConfigElement url = (UrlConfigElement)base["simple"]; return url; } } // Declare a collection element represented // in the configuration file by the sub-section // <urls> <add .../> </urls> // Note: the "IsDefaultCollection = false" // instructs the .NET Framework to build a nested // section like <urls> ...</urls>. [ConfigurationProperty("urls", IsDefaultCollection = false)] public UrlsCollection Urls { get { UrlsCollection urlsCollection = (UrlsCollection)base["urls"]; return urlsCollection; } } protected override void DeserializeSection( System.Xml.XmlReader reader) { base.DeserializeSection(reader); // You can add custom processing code here. } protected override string SerializeSection( ConfigurationElement parentElement, string name, ConfigurationSaveMode saveMode) { string s = base.SerializeSection(parentElement, name, saveMode); // You can add custom processing code here. return s; } } }
using System; using System.Configuration; using System.Collections; namespace Samples.AspNet { public class UrlsCollection : ConfigurationElementCollection { public UrlsCollection() { // Add one url to the collection. This is // not necessary; could leave the collection // empty until items are added to it outside // the constructor. UrlConfigElement url = (UrlConfigElement)CreateNewElement(); Add(url); } public override ConfigurationElementCollectionType CollectionType { get { return ConfigurationElementCollectionType.AddRemoveClearMap; } } protected override ConfigurationElement CreateNewElement() { return new UrlConfigElement(); } protected override ConfigurationElement CreateNewElement( string elementName) { return new UrlConfigElement(elementName); } protected override Object GetElementKey(ConfigurationElement element) { return ((UrlConfigElement)element).Name; } public new string AddElementName { get { return base.AddElementName; } set { base.AddElementName = value; } } public new string ClearElementName { get { return base.ClearElementName; } set { base.ClearElementName = value; } } public new string RemoveElementName { get { return base.RemoveElementName; } } public new int Count { get { return base.Count; } } public UrlConfigElement this[int index] { get { return (UrlConfigElement)BaseGet(index); } set { if (BaseGet(index) != null) { BaseRemoveAt(index); } BaseAdd(index, value); } } new public UrlConfigElement this[string Name] { get { return (UrlConfigElement)BaseGet(Name); } } public int IndexOf(UrlConfigElement url) { return BaseIndexOf(url); } public void Add(UrlConfigElement url) { BaseAdd(url); // Add custom code here. } protected override void BaseAdd(ConfigurationElement element) { BaseAdd(element, false); // Add custom code here. } public void Remove(UrlConfigElement url) { if (BaseIndexOf(url) >= 0) BaseRemove(url.Name); } public void RemoveAt(int index) { BaseRemoveAt(index); } public void Remove(string name) { BaseRemove(name); } public void Clear() { BaseClear(); // Add custom code here. } } }
using System; using System.Configuration; using System.Collections; namespace Samples.AspNet { public class UrlConfigElement : ConfigurationElement { // Constructor allowing name, url, and port to be specified. public UrlConfigElement(String newName, String newUrl, int newPort) { Name = newName; Url = newUrl; Port = newPort; } // Default constructor, will use default values as defined // below. public UrlConfigElement() { } // Constructor allowing name to be specified, will take the // default values for url and port. public UrlConfigElement(string elementName) { Name = elementName; } [ConfigurationProperty("name", DefaultValue = "Microsoft", IsRequired = true, IsKey = true)] public string Name { get { return (string)this["name"]; } set { this["name"] = value; } } [ConfigurationProperty("url", DefaultValue = "http://www.microsoft.com", IsRequired = true)] [RegexStringValidator(@"\w+:\/\/[\w.]+\S*")] public string Url { get { return (string)this["url"]; } set { this["url"] = value; } } [ConfigurationProperty("port", DefaultValue = (int)0, IsRequired = false)] [IntegerValidator(MinValue = 0, MaxValue = 8080, ExcludeRange = false)] public int Port { get { return (int)this["port"]; } set { this["port"] = value; } } protected override void DeserializeElement( System.Xml.XmlReader reader, bool serializeCollectionKey) { base.DeserializeElement(reader, serializeCollectionKey); // You can your custom processing code here. } protected override bool SerializeElement( System.Xml.XmlWriter writer, bool serializeCollectionKey) { bool ret = base.SerializeElement(writer, serializeCollectionKey); // You can enter your custom processing code here. return ret; } protected override bool IsModified() { bool ret = base.IsModified(); // You can enter your custom processing code here. return ret; } } }
Available since 2.0
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
.jpeg?cs-save-lang=1&cs-lang=csharp)
.jpeg?cs-save-lang=1&cs-lang=csharp)
.jpeg?cs-save-lang=1&cs-lang=csharp)
.jpeg?cs-save-lang=1&cs-lang=csharp)