This topic has not yet been rated - Rate this topic

ElementInformation Class

Contains meta-information about an individual element within the configuration. This class cannot be inherited.

System.Object
  System.Configuration.ElementInformation

Namespace:  System.Configuration
Assembly:  System.Configuration (in System.Configuration.dll)
public sealed class ElementInformation

The ElementInformation type exposes the following members.

  Name Description
Public property Errors Gets the errors for the associated element and subelements
Public property IsCollection Gets a value indicating whether the associated ConfigurationElement object is a ConfigurationElementCollection collection.
Public property IsLocked Gets a value that indicates whether the associated ConfigurationElement object cannot be modified.
Public property IsPresent Gets a value indicating whether the associated ConfigurationElement object is in the configuration file.
Public property LineNumber Gets the line number in the configuration file where the associated ConfigurationElement object is defined.
Public property Properties Gets a PropertyInformationCollection collection of the properties in the associated ConfigurationElement object.
Public property Source Gets the source file where the associated ConfigurationElement object originated.
Public property Type Gets the type of the associated ConfigurationElement object.
Public property Validator Gets the object used to validate the associated ConfigurationElement object.
Top
  Name Description
Public method Equals(Object) 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 GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top

The ElementInformation object contains meta-information about an individual element within the configuration. This object can be used when validating and changing the properties of an individual element.

The following example shows how to get the ElementInformation associated with a ConfigurationElement object.


static public ElementInformation
    GetElementInformation()
{

    // Get the current configuration file.
    System.Configuration.Configuration config =
            ConfigurationManager.OpenExeConfiguration(
            ConfigurationUserLevel.None);

    // Get the section.
    UrlsSection section =
        (UrlsSection)config.GetSection("MyUrls");

    // Get the element.
    UrlConfigElement url = section.Simple;

    ElementInformation eInfo =
        url.ElementInformation;

    return eInfo;

}


The following excerpt shows the configuration used by the previous code example.

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <configSections>
    <section name="MyUrls" type="Samples.AspNet.UrlsSection,
      ConfigurationElement, Version=1.0.0.0, Culture=neutral,
      PublicKeyToken=null" allowDefinition="Everywhere"
      allowExeDefinition="MachineToApplication"
      restartOnExternalChanges="true" />
  </configSections>
  <MyUrls name="MyFavorites">
    <simple name="Contoso" url="http://www.contoso.com" port="8080" />
    <urls>
      <clear />
      <add name="Microsoft" url="http://www.microsoft.com" port="0" />
    </urls>
  </MyUrls>
</configuration>

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ