GenericEnumConverter Class
Assembly: System.Configuration (in system.configuration.dll)
'Declaration Public NotInheritable Class GenericEnumConverter Inherits ConfigurationConverterBase 'Usage Dim instance As GenericEnumConverter
public final class GenericEnumConverter extends ConfigurationConverterBase
public final class GenericEnumConverter extends ConfigurationConverterBase
Not applicable.
This type, like all the other configuration converter types, converts strings found in the configuration file to and from the related strongly typed properties.
In particular, the GenericEnumConverter object converts a String value, assigned to a configuration property, to an Enum value and vice versa.
The following code example shows how to access a custom section property that uses the GenericEnumConverter type.
Imports System Imports System.IO Imports System.ComponentModel Imports System.Configuration NotInheritable Public Class UsingGenericEnumConverter Public Shared Sub GetPermission() Try Dim section As CustomSection = _ ConfigurationManager.GetSection("CustomSection") Console.WriteLine("Default Permission: {0}", _ section.Permission.ToString()) Catch e As System.Exception Console.WriteLine(e.Message) End Try End Sub 'GetPermission Public Shared Sub SetPermission() Try Dim config _ As System.Configuration.Configuration = _ ConfigurationManager.OpenExeConfiguration( _ ConfigurationUserLevel.None) Dim section As CustomSection = _ config.Sections.Get("CustomSection") section.Permission = _ CustomSection.Permissions.FullControl section.SectionInformation.ForceSave = True config.Save(ConfigurationSaveMode.Full) config.Save() Console.WriteLine( _ "Current Protection: {0}", _ section.Permission.ToString()) Catch e As System.Exception Console.WriteLine(e.Message) End Try End Sub 'SetPermission End Class 'UsingGenericEnumConverter
The following code example shows how to define a custom enumerator property accessed in the previous example. Notice that there is no need to specify the GenericEnumConverter type; it is implicitly invoked by the system.
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
The following example is a configuration excerpt 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" timeDelay="infinite" cdStr="str0, str1" permission="Read" maxUsers="Infinite"/>
</configuration>
System.ComponentModel.TypeConverter
System.Configuration.ConfigurationConverterBase
System.Configuration.GenericEnumConverter
Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.