GenericEnumConverter

.NET Framework クラス ライブラリ リファレンス

GenericEnumConverter クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

文字列と列挙型との間の変換を行います。

名前空間: System.Configuration
アセンブリ: System.Configuration (system.configuration.dll 内)
構文

Visual Basic (宣言)

Public NotInheritable Class
 GenericEnumConverter
    Inherits ConfigurationConverterBase

Visual Basic (使用法)

Dim instance As GenericEnumConverter

C#

public sealed class GenericEnumConverter :
 ConfigurationConverterBase

C++

public ref class GenericEnumConverter sealed
 : public ConfigurationConverterBase

J#

public final class GenericEnumConverter extends
 ConfigurationConverterBase

JScript

public final class GenericEnumConverter extends
 ConfigurationConverterBase

解説

この型は、他のすべての構成コンバータ型と同様に、構成ファイル内に存在する文字列と、関連する厳密に型指定されたプロパティとの間の変換を行います。

特に、GenericEnumConverter オブジェクトは、構成プロパティに代入された String 値から Enum 値への変換、およびその逆の変換を行います。

使用例

GenericEnumConverter 型を使用したカスタム セクション プロパティにアクセスする方法を次のコード例に示します。

Visual Basic

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

C#

using System;
using System.IO;
using System.ComponentModel;
using System.Configuration;

namespace Samples.AspNet
{
  
    public sealed class UsingGenericEnumConverter
    {
        public static void
 GetPermission()
        {
            try
            {
                CustomSection section =
                    ConfigurationManager.GetSection("CustomSection")
                    as CustomSection;
                
                Console.WriteLine("Default Permission: {0}", 
                    section.Permission.ToString());
            }
            catch (System.Exception e)
            {
                Console.WriteLine(e.Message);
            }
        }

        public static void
 SetPermission()
        {
            try
            {
                System.Configuration.Configuration config =
                  ConfigurationManager.OpenExeConfiguration(
                  ConfigurationUserLevel.None);

                CustomSection section =
                    config.Sections.Get("CustomSection")
                    as 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 (System.Exception e)
            {
                Console.WriteLine(e.Message);
            }
        }
    }
}

前述の例でアクセスしたカスタム列挙子プロパティを定義する方法を次のコード例に示します。GenericEnumConverter 型を指定する必要はありません。この型は、システムによって暗黙的に呼び出されます。

Visual Basic

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

C#

public enum Permissions
{
    FullControl         = 0,
    Modify              = 1,
    ReadExecute         = 2,
    Read                = 3,
    Write               = 4,
    SpecialPermissions  = 5
}

[ConfigurationProperty("permission", DefaultValue = Permissions.Read)]
public Permissions Permission
{
    get
    {
        return (Permissions)this["permission"];
    }

    set
    {
        this["permission"] = value;
    }

}

前述の例で使用されている構成の抜粋を次に示します。

<?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.Object
   System.ComponentModel.TypeConverter
     System.Configuration.ConfigurationConverterBase
      System.Configuration.GenericEnumConverter

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

Windows 98, Windows 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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
GenericEnumConverter メンバ
System.Configuration 名前空間
InfiniteIntConverter
InfiniteTimeSpanConverter
TimeSpanMinutesOrInfiniteConverter
TimeSpanSecondsConverter
TimeSpanSecondsOrInfiniteConverter
TypeNameConverter
WhiteSpaceTrimStringConverter

GenericEnumConverter コンストラクタ

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

GenericEnumConverter クラスの新しいインスタンスを初期化します。

名前空間: System.Configuration
アセンブリ: System.Configuration (system.configuration.dll 内)
構文

Visual Basic (宣言)

Public Sub New ( _
    typeEnum As Type _
)

Visual Basic (使用法)

Dim typeEnum As Type

Dim instance As New GenericEnumConverter(typeEnum)

C#

public GenericEnumConverter (
    Type typeEnum
)

C++

public:
GenericEnumConverter (
    Type^ typeEnum
)

J#

public GenericEnumConverter (
    Type typeEnum
)

JScript

public function GenericEnumConverter (
    typeEnum : Type
)

パラメータ

typeEnum

変換する列挙型。

解説

通常は、システムに用意されているコンバータ型を使用します。GenericEnumConverter コンストラクタを使用する必要があるのは、独自のコンバータ型を作成する場合だけです。

プラットフォーム

Windows 98, Windows 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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
GenericEnumConverter クラス
GenericEnumConverter メンバ
System.Configuration 名前空間

GenericEnumConverter メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	CanConvertFrom	オーバーロードされます。 変換できるかどうかを確認します。 ( ConfigurationConverterBase から継承されます。)
	CanConvertTo	オーバーロードされます。 変換できるかどうかを確認します。 ( ConfigurationConverterBase から継承されます。)
	ConvertFrom	オーバーロードされます。 String を Enum 型に変換します。
	ConvertFromInvariantString	オーバーロードされます。 インバリアント カルチャを使用して、値をコンバータの型に変換します。 ( TypeConverter から継承されます。)
	ConvertFromString	オーバーロードされます。 指定したテキストをオブジェクトに変換します。 ( TypeConverter から継承されます。)
	ConvertTo	オーバーロードされます。 Enum 型を String 値に変換します。
	ConvertToInvariantString	オーバーロードされます。 指定した値を、インバリアント カルチャを使用した文字列形式に変換します。 ( TypeConverter から継承されます。)
	ConvertToString	オーバーロードされます。 指定した値を文字列形式に変換します。 ( TypeConverter から継承されます。)
	CreateInstance	オーバーロードされます。 Object の一連のプロパティ値を指定して、そのオブジェクトを再作成します。 ( TypeConverter から継承されます。)
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetCreateInstanceSupported	オーバーロードされます。 このオブジェクトの値を変更するときに CreateInstance メソッドを呼び出して、新しい値を作成する必要があるかどうかを返します。 ( TypeConverter から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetProperties	オーバーロードされます。 value パラメータに指定された配列型のプロパティのコレクションを返します。 ( TypeConverter から継承されます。)
	GetPropertiesSupported	オーバーロードされます。 オブジェクトがプロパティをサポートしているかどうかを示す値を返します。 ( TypeConverter から継承されます。)
	GetStandardValues	オーバーロードされます。 型コンバータがデザインされた対象のデータ型の標準値のコレクションを返します。 ( TypeConverter から継承されます。)
	GetStandardValuesExclusive	オーバーロードされます。 GetStandardValues から返された標準値のコレクションが、排他的なリストかどうかを示す値を返します。 ( TypeConverter から継承されます。)
	GetStandardValuesSupported	オーバーロードされます。 リストから選択できる標準値セットをオブジェクトがサポートするかどうかを示す値を返します。 ( TypeConverter から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	IsValid	オーバーロードされます。 指定した値オブジェクトが型に対して有効かどうかを示す値を返します。 ( TypeConverter から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	GetConvertFromException	変換を実行できなかった場合にスローされる例外を返します。 ( TypeConverter から継承されます。)
	GetConvertToException	変換を実行できなかった場合にスローされる例外を返します。 ( TypeConverter から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)
	SortProperties	プロパティのコレクションを並べ替えます。 ( TypeConverter から継承されます。)

参照

関連項目

GenericEnumConverter クラス
System.Configuration 名前空間
InfiniteIntConverter
InfiniteTimeSpanConverter
TimeSpanMinutesOrInfiniteConverter
TimeSpanSecondsConverter
TimeSpanSecondsOrInfiniteConverter
TypeNameConverter
WhiteSpaceTrimStringConverter

GenericEnumConverter メンバ

文字列と列挙型との間の変換を行います。

GenericEnumConverter データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	GenericEnumConverter	GenericEnumConverter クラスの新しいインスタンスを初期化します。

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	CanConvertFrom	オーバーロードされます。 変換できるかどうかを確認します。 (ConfigurationConverterBase から継承されます。)
	CanConvertTo	オーバーロードされます。 変換できるかどうかを確認します。 (ConfigurationConverterBase から継承されます。)
	ConvertFrom	オーバーロードされます。 String を Enum 型に変換します。
	ConvertFromInvariantString	オーバーロードされます。 インバリアント カルチャを使用して、値をコンバータの型に変換します。 (TypeConverter から継承されます。)
	ConvertFromString	オーバーロードされます。 指定したテキストをオブジェクトに変換します。 (TypeConverter から継承されます。)
	ConvertTo	オーバーロードされます。 Enum 型を String 値に変換します。
	ConvertToInvariantString	オーバーロードされます。 指定した値を、インバリアント カルチャを使用した文字列形式に変換します。 (TypeConverter から継承されます。)
	ConvertToString	オーバーロードされます。 指定した値を文字列形式に変換します。 (TypeConverter から継承されます。)
	CreateInstance	オーバーロードされます。 Object の一連のプロパティ値を指定して、そのオブジェクトを再作成します。 (TypeConverter から継承されます。)
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetCreateInstanceSupported	オーバーロードされます。 このオブジェクトの値を変更するときに CreateInstance メソッドを呼び出して、新しい値を作成する必要があるかどうかを返します。 (TypeConverter から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetProperties	オーバーロードされます。 value パラメータに指定された配列型のプロパティのコレクションを返します。 (TypeConverter から継承されます。)
	GetPropertiesSupported	オーバーロードされます。 オブジェクトがプロパティをサポートしているかどうかを示す値を返します。 (TypeConverter から継承されます。)
	GetStandardValues	オーバーロードされます。 型コンバータがデザインされた対象のデータ型の標準値のコレクションを返します。 (TypeConverter から継承されます。)
	GetStandardValuesExclusive	オーバーロードされます。 GetStandardValues から返された標準値のコレクションが、排他的なリストかどうかを示す値を返します。 (TypeConverter から継承されます。)
	GetStandardValuesSupported	オーバーロードされます。 リストから選択できる標準値セットをオブジェクトがサポートするかどうかを示す値を返します。 (TypeConverter から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	IsValid	オーバーロードされます。 指定した値オブジェクトが型に対して有効かどうかを示す値を返します。 (TypeConverter から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	GetConvertFromException	変換を実行できなかった場合にスローされる例外を返します。 (TypeConverter から継承されます。)
	GetConvertToException	変換を実行できなかった場合にスローされる例外を返します。 (TypeConverter から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)
	SortProperties	プロパティのコレクションを並べ替えます。 (TypeConverter から継承されます。)

参照

関連項目

GenericEnumConverter クラス
System.Configuration 名前空間
InfiniteIntConverter
InfiniteTimeSpanConverter
TimeSpanMinutesOrInfiniteConverter
TimeSpanSecondsConverter
TimeSpanSecondsOrInfiniteConverter
TypeNameConverter
WhiteSpaceTrimStringConverter