ElementInformation Class

 

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

Namespace:   System.Configuration
Assembly:  System.Configuration (in System.Configuration.dll)

System.Object
  System.Configuration.ElementInformation

Public NotInheritable Class ElementInformation

NameDescription
System_CAPS_pubpropertyErrors

Gets the errors for the associated element and subelements

System_CAPS_pubpropertyIsCollection

Gets a value indicating whether the associated ConfigurationElement object is a ConfigurationElementCollection collection.

System_CAPS_pubpropertyIsLocked

Gets a value that indicates whether the associated ConfigurationElement object cannot be modified.

System_CAPS_pubpropertyIsPresent

Gets a value indicating whether the associated ConfigurationElement object is in the configuration file.

System_CAPS_pubpropertyLineNumber

Gets the line number in the configuration file where the associated ConfigurationElement object is defined.

System_CAPS_pubpropertyProperties

Gets a PropertyInformationCollection collection of the properties in the associated ConfigurationElement object.

System_CAPS_pubpropertySource

Gets the source file where the associated ConfigurationElement object originated.

System_CAPS_pubpropertyType

Gets the type of the associated ConfigurationElement object.

System_CAPS_pubpropertyValidator

Gets the object used to validate the associated ConfigurationElement object.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

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.

Public Shared Function GetElementInformation() _
As ElementInformation

    ' Get the current configuration file.
    Dim config _
    As System.Configuration.Configuration = _
    ConfigurationManager.OpenExeConfiguration( _
    ConfigurationUserLevel.None)

    ' Get the section.
    Dim section As UrlsSection = CType( _
    config.GetSection("MyUrls"), UrlsSection)

    ' Get the element.
    Dim url As UrlConfigElement = _
    section.Simple

    Dim eInfo As ElementInformation = _
    url.ElementInformation

    Return eInfo

End Function 'GetElementInformation     

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
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.

Return to top
Show: