Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ConfigurationConverterBase Class

 

The base class for the configuration converter types.

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


Public MustInherit Class ConfigurationConverterBase
	Inherits TypeConverter

NameDescription
System_CAPS_protmethodConfigurationConverterBase()

Initializes a new instance of the ConfigurationConverterBase class.

NameDescription
System_CAPS_pubmethodCanConvertFrom(ITypeDescriptorContext, Type)

Determines whether the conversion is allowed.(Overrides TypeConverter.CanConvertFrom(ITypeDescriptorContext, Type).)

System_CAPS_pubmethodCanConvertFrom(Type)

Returns whether this converter can convert an object of the given type to the type of this converter.(Inherited from TypeConverter.)

System_CAPS_pubmethodCanConvertTo(ITypeDescriptorContext, Type)

Determines whether the conversion is allowed.(Overrides TypeConverter.CanConvertTo(ITypeDescriptorContext, Type).)

System_CAPS_pubmethodCanConvertTo(Type)

Returns whether this converter can convert the object to the specified type.(Inherited from TypeConverter.)

System_CAPS_pubmethodConvertFrom(ITypeDescriptorContext, CultureInfo, Object)

Converts the given object to the type of this converter, using the specified context and culture information.(Inherited from TypeConverter.)

System_CAPS_pubmethodConvertFrom(Object)

Converts the given value to the type of this converter.(Inherited from TypeConverter.)

System_CAPS_pubmethodConvertFromInvariantString(ITypeDescriptorContext, String)

Converts the given string to the type of this converter, using the invariant culture and the specified context.(Inherited from TypeConverter.)

System_CAPS_pubmethodConvertFromInvariantString(String)

Converts the given string to the type of this converter, using the invariant culture.(Inherited from TypeConverter.)

System_CAPS_pubmethodConvertFromString(ITypeDescriptorContext, CultureInfo, String)

Converts the given text to an object, using the specified context and culture information.(Inherited from TypeConverter.)

System_CAPS_pubmethodConvertFromString(ITypeDescriptorContext, String)

Converts the given text to an object, using the specified context.(Inherited from TypeConverter.)

System_CAPS_pubmethodConvertFromString(String)

Converts the specified text to an object.(Inherited from TypeConverter.)

System_CAPS_pubmethodConvertTo(ITypeDescriptorContext, CultureInfo, Object, Type)

Converts the given value object to the specified type, using the specified context and culture information.(Inherited from TypeConverter.)

System_CAPS_pubmethodConvertTo(Object, Type)

Converts the given value object to the specified type, using the arguments.(Inherited from TypeConverter.)

System_CAPS_pubmethodConvertToInvariantString(ITypeDescriptorContext, Object)

Converts the specified value to a culture-invariant string representation, using the specified context.(Inherited from TypeConverter.)

System_CAPS_pubmethodConvertToInvariantString(Object)

Converts the specified value to a culture-invariant string representation.(Inherited from TypeConverter.)

System_CAPS_pubmethodConvertToString(ITypeDescriptorContext, CultureInfo, Object)

Converts the given value to a string representation, using the specified context and culture information.(Inherited from TypeConverter.)

System_CAPS_pubmethodConvertToString(ITypeDescriptorContext, Object)

Converts the given value to a string representation, using the given context.(Inherited from TypeConverter.)

System_CAPS_pubmethodConvertToString(Object)

Converts the specified value to a string representation.(Inherited from TypeConverter.)

System_CAPS_pubmethodCreateInstance(IDictionary)

Re-creates an Object given a set of property values for the object.(Inherited from TypeConverter.)

System_CAPS_pubmethodCreateInstance(ITypeDescriptorContext, IDictionary)

Creates an instance of the type that this TypeConverter is associated with, using the specified context, given a set of property values for the object.(Inherited from TypeConverter.)

System_CAPS_pubmethodEquals(Object)

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

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_protmethodGetConvertFromException(Object)

Returns an exception to throw when a conversion cannot be performed.(Inherited from TypeConverter.)

System_CAPS_protmethodGetConvertToException(Object, Type)

Returns an exception to throw when a conversion cannot be performed.(Inherited from TypeConverter.)

System_CAPS_pubmethodGetCreateInstanceSupported()

Returns whether changing a value on this object requires a call to the CreateInstance method to create a new value.(Inherited from TypeConverter.)

System_CAPS_pubmethodGetCreateInstanceSupported(ITypeDescriptorContext)

Returns whether changing a value on this object requires a call to CreateInstance to create a new value, using the specified context.(Inherited from TypeConverter.)

System_CAPS_pubmethodGetHashCode()

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

System_CAPS_pubmethodGetProperties(ITypeDescriptorContext, Object)

Returns a collection of properties for the type of array specified by the value parameter, using the specified context.(Inherited from TypeConverter.)

System_CAPS_pubmethodGetProperties(ITypeDescriptorContext, Object, Attribute())

Returns a collection of properties for the type of array specified by the value parameter, using the specified context and attributes.(Inherited from TypeConverter.)

System_CAPS_pubmethodGetProperties(Object)

Returns a collection of properties for the type of array specified by the value parameter.(Inherited from TypeConverter.)

System_CAPS_pubmethodGetPropertiesSupported()

Returns whether this object supports properties.(Inherited from TypeConverter.)

System_CAPS_pubmethodGetPropertiesSupported(ITypeDescriptorContext)

Returns whether this object supports properties, using the specified context.(Inherited from TypeConverter.)

System_CAPS_pubmethodGetStandardValues()

Returns a collection of standard values from the default context for the data type this type converter is designed for.(Inherited from TypeConverter.)

System_CAPS_pubmethodGetStandardValues(ITypeDescriptorContext)

Returns a collection of standard values for the data type this type converter is designed for when provided with a format context.(Inherited from TypeConverter.)

System_CAPS_pubmethodGetStandardValuesExclusive()

Returns whether the collection of standard values returned from GetStandardValues is an exclusive list.(Inherited from TypeConverter.)

System_CAPS_pubmethodGetStandardValuesExclusive(ITypeDescriptorContext)

Returns whether the collection of standard values returned from GetStandardValues is an exclusive list of possible values, using the specified context.(Inherited from TypeConverter.)

System_CAPS_pubmethodGetStandardValuesSupported()

Returns whether this object supports a standard set of values that can be picked from a list.(Inherited from TypeConverter.)

System_CAPS_pubmethodGetStandardValuesSupported(ITypeDescriptorContext)

Returns whether this object supports a standard set of values that can be picked from a list, using the specified context.(Inherited from TypeConverter.)

System_CAPS_pubmethodGetType()

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

System_CAPS_pubmethodIsValid(ITypeDescriptorContext, Object)

Returns whether the given value object is valid for this type and for the specified context.(Inherited from TypeConverter.)

System_CAPS_pubmethodIsValid(Object)

Returns whether the given value object is valid for this type.(Inherited from TypeConverter.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodSortProperties(PropertyDescriptorCollection, String())

Sorts a collection of properties.(Inherited from TypeConverter.)

System_CAPS_pubmethodToString()

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

The ConfigurationConverterBase is the base class for the converter configuration types. These are types that convert strings, found in the configuration file, to and from the related strongly typed properties.

The following code examples show how to derive from the ConfigurationConverterBase class to create a custom TimeSpan converter type. Also, the examples show how to use this type in a custom section.

The following code example shows how to create a custom TimeSpan converter type from the ConfigurationConverterBase class.

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports System.Configuration
Imports System.Globalization
Imports System.ComponentModel




NotInheritable Public Class CustomTimeSpanMinutesConverter
    Inherits ConfigurationConverterBase

    Friend Function ValidateType(ByVal value As Object, _
    ByVal expected As Type) As Boolean
        Dim result As Boolean

        If Not (value Is Nothing) _
        AndAlso value.ToString() <> expected.ToString() Then
            result = False
        Else
            result = True
        End If
        Return result

    End Function 'ValidateType


    Public Overrides Function CanConvertTo( _
    ByVal ctx As ITypeDescriptorContext, _
    ByVal type As Type) As Boolean
        Return (type.ToString() = GetType(String).ToString())

    End Function 'CanConvertTo

    Public Overrides Function CanConvertFrom( _
    ByVal ctx As ITypeDescriptorContext, _
    ByVal type As Type) As Boolean
        Return (type.ToString() = GetType(String).ToString())

    End Function 'CanConvertFrom

    Public Overrides Function ConvertTo( _
    ByVal ctx As ITypeDescriptorContext, _
    ByVal ci As CultureInfo, ByVal value As Object, _
    ByVal type As Type) As Object
        ValidateType(value, GetType(TimeSpan))

        Dim data As Long = _
        Fix(CType(value, TimeSpan).TotalMinutes)

        Return data.ToString(CultureInfo.InvariantCulture)

    End Function 'ConvertTo

    Public Overrides Function ConvertFrom( _
    ByVal ctx As ITypeDescriptorContext, _
    ByVal ci As CultureInfo, ByVal data As Object) As Object

        Dim min As Long = _
        Long.Parse(CStr(data), CultureInfo.InvariantCulture)

        Return TimeSpan.FromMinutes(System.Convert.ToDouble(min))

    End Function 'ConvertFrom

End Class 'CustomTimeSpanMinutesConverter 

The following code example shows how to define a custom section that uses the previous custom TimeSpan converter.

' Define a custom section.
NotInheritable Public Class CustomSection
    Inherits ConfigurationSection


    Public Sub New() 

    End Sub 'NewNew



    <ConfigurationProperty("fileName", _
    DefaultValue:="   default.txt  "), _
    TypeConverter(GetType(WhiteSpaceTrimStringConverter))> _
    Public Property FileName() As String
        Get
            Return CStr(Me("fileName"))
        End Get
        Set(ByVal value As String)
            Me("fileName") = value
        End Set
    End Property


    <ConfigurationProperty("maxIdleTime"), _
    TypeConverter(GetType(CustomizedTimeSpanMinutesConverter))> _
    Public Property MaxIdleTime() As TimeSpan
        Get
            Return CType(Me("maxIdleTime"), TimeSpan)
        End Get
        Set(ByVal value As TimeSpan)
            Me("maxIdleTime") = value
        End Set
    End Property

    <ConfigurationProperty("timeDelay", _
    DefaultValue:="infinite"), _
    TypeConverter(GetType(InfiniteTimeSpanConverter))> _
    Public Property TimeDelay() As TimeSpan
        Get
            Return CType(Me("timeDelay"), TimeSpan)
        End Get
        Set(ByVal value As TimeSpan)
            Me("timeDelay") = Value
        End Set
    End Property

    <ConfigurationProperty("cdStr", _
    DefaultValue:="str0, str1", _
    IsRequired:=True), _
    TypeConverter(GetType(CommaDelimitedStringCollectionConverter))> _
    Public Property CdStr() As StringCollection
        Get
            Return CType(Me("cdStr"), StringCollection)
        End Get

        Set(ByVal value As StringCollection)
            Me("cdStr") = value
        End Set
    End Property


    Public Enum Permissions
        FullControl = 0
        Modify = 1
        ReadExecute = 2
        Read = 3
        Write = 4
        SpecialPermissions = 5
    End Enum 'Permissions


    <ConfigurationProperty("permission", _
    DefaultValue:=Permissions.Read)> _
    Public Property Permission() As Permissions
        Get
            Return CType(Me("permission"), Permissions)
        End Get

        Set(ByVal value As Permissions)
            Me("permission") = Value
        End Set
    End Property


    <ConfigurationProperty("maxUsers", _
    DefaultValue:="infinite"), _
    TypeConverter(GetType(InfiniteIntConverter))> _
    Public Property MaxUsers() As Integer
        Get
            Return Fix(Me("maxUsers"))
        End Get
        Set(ByVal value As Integer)
            Me("maxUsers") = Value
        End Set
    End Property
End Class 'CustomSection 

The following code example shows how to create and modify a configuration file using the previous custom section.

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports System.Configuration
Imports System.Globalization
Imports System.ComponentModel



' Define a custom section.

NotInheritable Public Class CustomSection
   Inherits ConfigurationSection


   Public Sub New()
   End Sub 'NewNew


    <ConfigurationProperty("fileName", _
    DefaultValue:="default.txt", _
    IsRequired:=True, IsKey:=False), _
    StringValidator(InvalidCharacters:=" ~!@#$%^&*()[]{}/;'""|\", _
    MinLength:=1, MaxLength:=60)> _
    Public Property FileName() As String
        Get
            Return CStr(Me("fileName"))
        End Get
        Set(ByVal value As String)
            Me("fileName") = value
        End Set
    End Property



    <ConfigurationProperty("maxIdleTime"), _
    TypeConverter(GetType(TsMinutesConverter))> _
    Public Property MaxIdleTime() As TimeSpan
        Get
            Return CType(Me("maxIdleTime"), TimeSpan)
        End Get
        Set(ByVal value As TimeSpan)
            Me("maxIdleTime") = Value
        End Set
    End Property

End Class 'CustomSection 


NotInheritable Public Class TsMinutesConverter
   Inherits ConfigurationConverterBase

   Friend Function ValidateType(value As Object, expected As Type) As Boolean
      Dim result As Boolean

        If Not (value Is Nothing) _
        AndAlso (value.GetType().Equals(expected) <> True) Then
            result = False
        Else
            result = True
        End If
      Return result
   End Function 'ValidateType


    Public Overrides Function CanConvertTo( _
    ByVal ctx As ITypeDescriptorContext, _
    ByVal type As Type) As Boolean

        Return type.Equals(GetType(String))

    End Function 'CanConvertTo


    Public Overrides Function CanConvertFrom( _
    ByVal ctx As ITypeDescriptorContext, _
    ByVal type As Type) As Boolean

        Return type.Equals(GetType(String))

    End Function 'CanConvertFrom


    Public Overrides Function ConvertTo( _
    ByVal ctx As ITypeDescriptorContext, ByVal ci As CultureInfo, _
    ByVal value As Object, ByVal type As Type) As Object
        ValidateType(value, GetType(TimeSpan))

        Dim data As Long = _
        Fix(CType(value, TimeSpan).TotalMinutes)

        Return data.ToString(CultureInfo.InvariantCulture)

    End Function 'ConvertTo


    Public Overrides Function ConvertFrom( _
    ByVal ctx As ITypeDescriptorContext, ByVal ci As CultureInfo, _
    ByVal data As Object) As Object

        Dim min As Long = _
        Long.Parse(CStr(data), _
        CultureInfo.InvariantCulture)

        Return TimeSpan.FromMinutes( _
        System.Convert.ToDouble(min))

    End Function 'ConvertFrom
End Class 'TsMinutesConverter

Class UsingConfigutationConverterBase


   ' Create a custom section.
   Shared Sub CreateSection()
      Try

         Dim customSection As CustomSection

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

         ' Create the section entry  
         ' in the <configSections> and the 
         ' related target section in <configuration>.
         If config.Sections("CustomSection") Is Nothing Then
            customSection = New CustomSection()
            config.Sections.Add("CustomSection", customSection)
            customSection.SectionInformation.ForceSave = True
            config.Save(ConfigurationSaveMode.Full)
         End If
      Catch err As ConfigurationErrorsException
         Console.WriteLine(err.ToString())
      End Try
   End Sub 'CreateSection



   ' Change custom section and write it to disk.
   Shared Sub SerializeCustomSection()
      Try
            Dim config _
               As System.Configuration.Configuration = _
               ConfigurationManager.OpenExeConfiguration( _
               ConfigurationUserLevel.None)

            Dim customSection _
            As CustomSection = _
            config.Sections.Get("CustomSection")
         Dim ts As New TimeSpan(1, 30, 30)

         customSection.MaxIdleTime = ts

         config.Save()

            Dim maxIdleTime As String = _
            customSection.MaxIdleTime.ToString()

            Console.WriteLine( _
            "New max idle time: {0}", maxIdleTime)
      Catch e As Exception
         Console.WriteLine(e.ToString())
      End Try
   End Sub 'SerializeCustomSection


   ' Read custom section from disk.
   Shared Sub DeserializeCustomSection()

      Try
            Dim config _
            As System.Configuration.Configuration = _
            ConfigurationManager.OpenExeConfiguration( _
            ConfigurationUserLevel.None)

            Dim customSection _
            As CustomSection = _
            config.Sections.Get("CustomSection")

            Dim maxIdleTime As TimeSpan = _
            customSection.MaxIdleTime


            Console.WriteLine( _
            "Max idle time: {0}", maxIdleTime.ToString())
      Catch e As Exception
         Console.WriteLine(e.ToString())
      End Try
   End Sub 'DeserializeCustomSection


    Public Overloads Shared Sub Main(ByVal args() As String)
        CreateSection()
        SerializeCustomSection()
        DeserializeCustomSection()
    End Sub 'Main 
End Class 'UsingConfigutationConverterBase

The following is a configuration excerpt as used by the previous example.

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <configSections>
    <section name="CustomSection" 
      type="Samples.AspNet.CustomSection, 
      ConfigurationConverters, 
      Version=1.0.0.0, Culture=neutral, 
      PublicKeyToken=null" 
      allowDefinition="Everywhere" 
      allowExeDefinition="MachineToApplication" 
      restartOnExternalChanges="true" />
  </configSections>
  <CustomSection fileName="default.txt" maxIdleTime="90" />
</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:
© 2016 Microsoft