PropertyInformation Class

Contains meta-information on an individual property within the configuration. This type cannot be inherited.

System.Object
  System.Configuration.PropertyInformation

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

'Declaration
Public NotInheritable Class PropertyInformation

The PropertyInformation type exposes the following members.

  NameDescription
Public propertyConverterGets the TypeConverter object related to the configuration attribute.
Public propertyDefaultValueGets an object containing the default value related to a configuration attribute.
Public propertyDescriptionGets the description of the object that corresponds to a configuration attribute.
Public propertyIsKeyGets a value specifying whether the configuration attribute is a key.
Public propertyIsLockedGets a value specifying whether the configuration attribute is locked.
Public propertyIsModifiedGets a value specifying whether the configuration attribute has been modified.
Public propertyIsRequiredGets a value specifying whether the configuration attribute is required.
Public propertyLineNumberGets the line number in the configuration file related to the configuration attribute.
Public propertyNameGets the name of the object that corresponds to a configuration attribute.
Public propertySourceGets the source file that corresponds to a configuration attribute.
Public propertyTypeGets the Type of the object that corresponds to a configuration attribute.
Public propertyValidatorGets a ConfigurationValidatorBase object related to the configuration attribute.
Public propertyValueGets or sets an object containing the value related to a configuration attribute.
Public propertyValueOriginGets a PropertyValueOrigin object related to the configuration attribute.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

The PropertyInformation object contains the meta-information of an individual property within the configuration. This object can be used when validating and changing the properties of an individual attribute.

The PropertyInformation object is derived from the associated PropertyInformationCollection object. The PropertyInformationCollection object is derived from the associated ElementInformation object.

The following code example demonstrates how to use the PropertyInformation type.

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports System.Configuration
Imports System.Web
Imports System.Web.Configuration

Namespace Samples.ConfigurationExamples
  Class UsingPropertyInformation
    Public Shared Sub Main()
      Try 
        ' Set the path of the config file. 
        Dim configPath As String = "" 

        ' Get the Web application configuration object. 
        Dim config As Configuration = _
          WebConfigurationManager.OpenWebConfiguration(configPath)

        ' Get the section related object. 

        Dim configSection As AnonymousIdentificationSection = _
        CType(config.GetSection("system.web/anonymousIdentification"), _
        AnonymousIdentificationSection)

        ' Display title.
        Console.WriteLine("Configuration PropertyInformation")
        Console.WriteLine("Section: anonymousIdentification")

        ' Instantiate a new PropertyInformationCollection object. 
        Dim propCollection As PropertyInformationCollection = _
         configSection.ElementInformation.Properties()

        ' Display Collection Count.
        Console.WriteLine("Collection Count: {0}", _
          propCollection.Count)

        ' Display properties of elements  
        ' of the PropertyInformationCollection. 
        For Each propertyItem As PropertyInformation In propCollection
          Console.WriteLine()
          Console.WriteLine("Property Details:")

          ' Display the Name property.
          Console.WriteLine("Name: {0}", propertyItem.Name)

          ' Display the Value property.
          Console.WriteLine("Value: {0}", propertyItem.Value)

          ' Display the DefaultValue property.
          Console.WriteLine("DefaultValue: {0}", _
            propertyItem.DefaultValue) _

          ' Display the Type property.
          Console.WriteLine("Type: {0}", propertyItem.Type)

          ' Display the IsKey property.
          Console.WriteLine("IsKey: {0}", propertyItem.IsKey)

          ' Display the IsLocked property.
          Console.WriteLine("IsLocked: {0}", propertyItem.IsLocked)

          ' Display the IsModified property.
          Console.WriteLine("IsModified: {0}", propertyItem.IsModified)

          ' Display the IsRequired property.
          Console.WriteLine("IsRequired: {0}", propertyItem.IsRequired)

          ' Display the LineNumber property.
          Console.WriteLine("LineNumber: {0}", propertyItem.LineNumber)

          ' Display the Source property.
          Console.WriteLine("Source: {0}", propertyItem.Source)

          ' Display the Validator property.
          Console.WriteLine("Validator: {0}", propertyItem.Validator)

          ' Display the ValueOrigin property.
          Console.WriteLine("ValueOrigin: {0}", propertyItem.ValueOrigin)
        Next

        Console.WriteLine("")
        Console.WriteLine("Configuration - Accessing an Attribute")
        ' Create EllementInformation object. 
        Dim elementInfo As ElementInformation = _
        configSection.ElementInformation()
        ' Create a PropertyInformationCollection object. 
        Dim propertyInfoCollection As PropertyInformationCollection = _
        elementInfo.Properties()
        ' Create a PropertyInformation object. 
        Dim myPropertyInfo As PropertyInformation = _
          propertyInfoCollection("enabled")
        ' Display the property value.
        Console.WriteLine _
          ("anonymousIdentification Section - Enabled: {0}", _
          myPropertyInfo.Value)

      Catch e As Exception
        ' Error.
        Console.WriteLine("Error: {0}", _
          e.Message.ToString())
      End Try 

      ' Display and wait.
      Console.ReadLine()
    End Sub 
  End Class 
End Namespace

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft