System.Resources.ResourceReader クラス

この記事では、この API のリファレンス ドキュメントに補足的な解説を提供します。

ResourceReader クラスは、IResourceReader インターフェイスの標準実装を提供します。 ResourceReader インスタンスは、スタンドアロンの .resources ファイルまたはアセンブリに埋め込まれている .resources ファイルを表します。 これは、.resources ファイル内のリソースを列挙し、その名前と値のペアを取得するために使用されます。 アセンブリに埋め込まれている .resources ファイルから指定された名前付きリソースを取得するために使用される ResourceManager クラスとは異なります。 ResourceManager クラスは、名前が事前にわかっているリソースを取得するために使用されますが、ResourceReader クラスは、コンパイル時に番号または正確な名前が不明なリソースを取得する場合に便利です。 たとえば、アプリケーションはリソース ファイルを使用して、セクションとセクション内の項目に編成された構成情報を格納できます。セクション内のセクションまたは項目の数が事前にわかっていません。 その後、リソースに一般的に名前を付け (Section1、Section1Item1、Section1Item2など)、ResourceReader オブジェクトを使用して取得できます。

ResourceReader オブジェクトをインスタンス化する

.resources ファイルは、Resgen.exe (リソース ファイル ジェネレーター)によってテキスト ファイルまたは XML .resx ファイルからコンパイルされたバイナリ ファイルです。 ResourceReader オブジェクトは、スタンドアロンの .resources ファイルまたはアセンブリに埋め込まれている .resources ファイルを表すことができます。

スタンドアロンの .resources ファイルから読み取る ResourceReader オブジェクトをインスタンス化するには、入力ストリームまたは .resources ファイル名を含む文字列と共に ResourceReader クラス コンストラクターを使用します。 次の例は、両方の方法を示しています。 最初のオブジェクトは、そのファイル名を使用して ResourceReader という名前の .resources ファイルを表す Resources1.resources オブジェクトをインスタンス化します。 2 つ目は、ファイルから作成されたストリームを使用して、ResourceReader という名前の .resources ファイルを表す Resources2.resources オブジェクトをインスタンス化します。

// Instantiate a standalone .resources file from its filename.
var rr1 = new System.Resources.ResourceReader("Resources1.resources");

// Instantiate a standalone .resources file from a stream.
var fs = new System.IO.FileStream(@".\Resources2.resources",
                                  System.IO.FileMode.Open);
var rr2 = new System.Resources.ResourceReader(fs);

' Instantiate a standalone .resources file from its filename.
Dim rr1 As New System.Resources.ResourceReader("Resources1.resources")

' Instantiate a standalone .resources file from a stream.
Dim fs As New System.IO.FileStream(".\Resources2.resources",
                                   System.IO.FileMode.Open)
Dim rr2 As New System.Resources.ResourceReader(fs)

埋め込み .resources ファイルを表す ResourceReader オブジェクトを作成するには、.resources ファイルが埋め込まれているアセンブリから Assembly オブジェクトをインスタンス化します。 その Assembly.GetManifestResourceStream メソッドは、Stream コンストラクターに渡すことができる ResourceReader(Stream) オブジェクトを返します。 次の例では、埋め込み .resources ファイルを表す ResourceReader オブジェクトをインスタンス化します。

System.Reflection.Assembly assem =
             System.Reflection.Assembly.LoadFrom(@".\MyLibrary.dll");
System.IO.Stream fs =
             assem.GetManifestResourceStream("MyCompany.LibraryResources.resources");
var rr = new System.Resources.ResourceReader(fs);

Dim assem As System.Reflection.Assembly = 
             System.Reflection.Assembly.LoadFrom(".\MyLibrary.dll") 
Dim fs As System.IO.Stream = 
             assem.GetManifestResourceStream("MyCompany.LibraryResources.resources")
Dim rr As New System.Resources.ResourceReader(fs)

ResourceReader オブジェクトのリソースを列挙する

.resources ファイル内のリソースを列挙するには、GetEnumerator オブジェクトを返す System.Collections.IDictionaryEnumerator メソッドを呼び出します。 IDictionaryEnumerator.MoveNext メソッドを呼び出して、リソース間を移動します。 このメソッドは、.resources ファイル内のすべてのリソースが列挙されている場合に false を返します。

コレクション内の個々のリソースは、次の 2 つの方法で取得できます。

• System.Collections.IDictionaryEnumerator コレクション内の各リソースを反復処理し、System.Collections.IDictionaryEnumerator プロパティを使用してリソースの名前と値を取得できます。 すべてのリソースが同じ種類の場合、または各リソースのデータ型がわかっている場合は、この手法をお勧めします。

• System.Collections.IDictionaryEnumerator コレクションを反復処理し、GetResourceData メソッドを呼び出してリソースのデータを取得するときに、各リソースの名前を取得できます。 各リソースのデータ型がわからない場合、または前の方法で例外がスローされる場合は、この方法をお勧めします。

IDictionaryEnumerator プロパティを使用してリソースを取得する

.resources ファイル内のリソースを列挙する最初の方法は、各リソースの名前と値のペアを直接取得することです。 IDictionaryEnumerator.MoveNext メソッドを呼び出してコレクション内の各リソースに移動した後、IDictionaryEnumerator.Key プロパティからリソース名を取得し、IDictionaryEnumerator.Value プロパティからリソース データを取得できます。

次の例では、IDictionaryEnumerator.Key プロパティと IDictionaryEnumerator.Value プロパティを使用して、.resources ファイル内の各リソースの名前と値を取得する方法を示します。 この例を実行するには、文字列リソースを定義する ApplicationResources.txt という名前の次のテキスト ファイルを作成します。

Title="Contact Information"
Label1="First Name:"
Label2="Middle Name:"
Label3="Last Name:"
Label4="SSN:"
Label5="Street Address:"
Label6="City:"
Label7="State:"
Label8="Zip Code:"
Label9="Home Phone:"
Label10="Business Phone:"
Label11="Mobile Phone:"
Label12="Other Phone:"
Label13="Fax:"
Label14="Email Address:"
Label15="Alternate Email Address:"

次のコマンドを使用して、テキスト リソース ファイルを ApplicationResources.resources という名前のバイナリ ファイルに変換できます。

resgen ApplicationResources.txt

次の例では、ResourceReader クラスを使用して、スタンドアロン バイナリ .resources ファイル内の各リソースを列挙し、そのキー名と対応する値を表示します。

using System;
using System.Collections;
using System.Resources;

public class Example1
{
   public static void Run()
   {
      Console.WriteLine("Resources in ApplicationResources.resources:");
      ResourceReader res = new ResourceReader(@".\ApplicationResources.resources");
      IDictionaryEnumerator dict = res.GetEnumerator();
      while (dict.MoveNext())
         Console.WriteLine($"   {dict.Key}: '{dict.Value}' (Type {dict.Value.GetType().Name})");
      res.Close();
   }
}
// The example displays the following output:
//       Resources in ApplicationResources.resources:
//          Label3: '"Last Name:"' (Type String)
//          Label2: '"Middle Name:"' (Type String)
//          Label1: '"First Name:"' (Type String)
//          Label7: '"State:"' (Type String)
//          Label6: '"City:"' (Type String)
//          Label5: '"Street Address:"' (Type String)
//          Label4: '"SSN:"' (Type String)
//          Label9: '"Home Phone:"' (Type String)
//          Label8: '"Zip Code:"' (Type String)
//          Title: '"Contact Information"' (Type String)
//          Label12: '"Other Phone:"' (Type String)
//          Label13: '"Fax:"' (Type String)
//          Label10: '"Business Phone:"' (Type String)
//          Label11: '"Mobile Phone:"' (Type String)
//          Label14: '"Email Address:"' (Type String)
//          Label15: '"Alternate Email Address:"' (Type String)

Imports System.Collections
Imports System.Resources

Module Example2
    Public Sub Main()
        Console.WriteLine("Resources in ApplicationResources.resources:")
        Dim res As New ResourceReader(".\ApplicationResources.resources")
        Dim dict As IDictionaryEnumerator = res.GetEnumerator()
        Do While dict.MoveNext()
            Console.WriteLine("   {0}: '{1}' (Type {2})", dict.Key, dict.Value, dict.Value.GetType().Name)
        Loop
        res.Close()
    End Sub
End Module
' The example displays output like the following:
'       Resources in ApplicationResources.resources:
'          Label3: '"Last Name:"' (Type String)
'          Label2: '"Middle Name:"' (Type String)
'          Label1: '"First Name:"' (Type String)
'          Label7: '"State:"' (Type String)
'          Label6: '"City:"' (Type String)
'          Label5: '"Street Address:"' (Type String)
'          Label4: '"SSN:"' (Type String)
'          Label9: '"Home Phone:"' (Type String)
'          Label8: '"Zip Code:"' (Type String)
'          Title: '"Contact Information"' (Type String)
'          Label12: '"Other Phone:"' (Type String)
'          Label13: '"Fax:"' (Type String)
'          Label10: '"Business Phone:"' (Type String)
'          Label11: '"Mobile Phone:"' (Type String)
'          Label14: '"Email Address:"' (Type String)
'          Label15: '"Alternate Email Address:"' (Type String)

IDictionaryEnumerator.Value プロパティからリソース データを取得しようとすると、以下の例外が発生する可能性があります。

• データが期待される形式でない場合には、FormatExceptionが生成されます。
• データが属する型を含むアセンブリが見つからない場合には、FileNotFoundExceptionが発生します。
• データが属する型が見つからない場合は、TypeLoadException になります。

通常、これらの例外は、.resources ファイルが手動で変更された場合、型が定義されているアセンブリがアプリケーションに含まれていないか、誤って削除された場合、またはアセンブリが型より前の古いバージョンである場合にスローされます。 これらの例外のいずれかがスローされた場合は、次のセクションに示すように、各リソースを列挙し、GetResourceData メソッドを呼び出すことによってリソースを取得できます。 この方法では、IDictionaryEnumerator.Value プロパティが返そうとしたデータ型に関するいくつかの情報が提供されます。

GetResourceData を使用して名前でリソースを取得する

.resources ファイル内のリソースを列挙する 2 番目の方法では、IDictionaryEnumerator.MoveNext メソッドを呼び出してファイル内のリソース間を移動することも含まれます。 リソースごとに、リソースの名前を IDictionaryEnumerator.Key プロパティから取得し、GetResourceData(String, String, Byte[]) メソッドに渡してリソースのデータを取得します。 これは、resourceData 引数のバイト配列として返されます。

この方法は、リソース値を形成する実際のバイトを返すので、IDictionaryEnumerator.Key プロパティと IDictionaryEnumerator.Value プロパティからリソース名と値を取得するよりも厄介です。 ただし、リソースを取得しようとすると例外がスローされた場合、GetResourceData メソッドは、リソースのデータ型に関する情報を指定することで、例外のソースを識別するのに役立ちます。 リソースのデータ型を示す文字列の詳細については、GetResourceDataを参照してください。

次の例は、このアプローチを使用してリソースを取得する方法、およびスローされた例外を処理する方法を示しています。 プログラムによって、4 つの文字列、1 つのブール値、1 つの整数、および 1 つのビットマップを含むバイナリ .resources ファイルが作成されます。 この例を実行するには、次の操作を行います。

1. 次のソース コードをコンパイルして実行し、ContactResources.resources という名前の .resources ファイルを作成します。

   using System.Drawing;
   using System.Drawing.Imaging;
   using System.IO;
   using System.Resources;
   using System.Runtime.Versioning;
   
   public class Example5
   {
       [SupportedOSPlatform("windows")]
       public static void Run()
       {
           // Bitmap as stream.
           MemoryStream bitmapStream = new MemoryStream();
           Bitmap bmp = new Bitmap(@".\ContactsIcon.jpg");
           bmp.Save(bitmapStream, ImageFormat.Jpeg);
   
           // Define resources to be written.
           using (ResourceWriter rw = new ResourceWriter(@".\ContactResources.resources"))
           {
               rw.AddResource("Title", "Contact List");
               rw.AddResource("NColumns", 5);
               rw.AddResource("Icon", bitmapStream);
               rw.AddResource("Header1", "Name");
               rw.AddResource("Header2", "City");
               rw.AddResource("Header3", "State");
               rw.AddResource("ClientVersion", true);
               rw.Generate();
           }
       }
   }
   

   ソース コード ファイルの名前は CreateResources.cs です。 次のコマンドを使用して、C# でコンパイルできます。

   csc CreateResources.cs /r:library.dll
   

2. 次のコードをコンパイルして実行し、ContactResources.resources ファイル内のリソースを列挙します。

   using System;
   using System.Collections;
   using System.Drawing;
   using System.IO;
   using System.Resources;
   using System.Runtime.Versioning;
   
   public class Example6
   {
       [SupportedOSPlatform("windows")]
       public static void Run()
       {
           ResourceReader rdr = new ResourceReader(@".\ContactResources.resources");
           IDictionaryEnumerator dict = rdr.GetEnumerator();
           while (dict.MoveNext())
           {
               Console.WriteLine($"Resource Name: {dict.Key}");
               try
               {
                   Console.WriteLine($"   Value: {dict.Value}");
               }
               catch (FileNotFoundException)
               {
                   Console.WriteLine("   Exception: A file cannot be found.");
                   DisplayResourceInfo(rdr, (string)dict.Key, false);
               }
               catch (FormatException)
               {
                   Console.WriteLine("   Exception: Corrupted data.");
                   DisplayResourceInfo(rdr, (string)dict.Key, true);
               }
               catch (TypeLoadException)
               {
                   Console.WriteLine("   Exception: Cannot load the data type.");
                   DisplayResourceInfo(rdr, (string)dict.Key, false);
               }
           }
       }
   
       [SupportedOSPlatform("windows")]
       private static void DisplayResourceInfo(ResourceReader rr,
                                       string key, bool loaded)
       {
           string dataType = null;
           byte[] data = null;
           rr.GetResourceData(key, out dataType, out data);
   
           // Display the data type.
           Console.WriteLine($"   Data Type: {dataType}");
           // Display the bytes that form the available data.      
           Console.Write("   Data: ");
           int lines = 0;
           foreach (var dataItem in data)
           {
               lines++;
               Console.Write("{0:X2} ", dataItem);
               if (lines % 25 == 0)
                   Console.Write("\n         ");
           }
           Console.WriteLine();
           // Try to recreate current state of data.
           // Do: Bitmap, DateTimeTZI
           switch (dataType)
           {
               // Handle internally serialized string data (ResourceTypeCode members).
               case "ResourceTypeCode.String":
                   BinaryReader reader = new BinaryReader(new MemoryStream(data));
                   string binData = reader.ReadString();
                   Console.WriteLine($"   Recreated Value: {binData}");
                   break;
               case "ResourceTypeCode.Int32":
                   Console.WriteLine($"   Recreated Value: {BitConverter.ToInt32(data, 0)}");
                   break;
               case "ResourceTypeCode.Boolean":
                   Console.WriteLine($"   Recreated Value: {BitConverter.ToBoolean(data, 0)}");
                   break;
               // .jpeg image stored as a stream.
               case "ResourceTypeCode.Stream":
                   const int OFFSET = 4;
                   int size = BitConverter.ToInt32(data, 0);
                   Bitmap value1 = new Bitmap(new MemoryStream(data, OFFSET, size));
                   Console.WriteLine($"   Recreated Value: {value1}");
                   break;
               default:
                   break;
           }
           Console.WriteLine();
       }
   }
   

   ソース コードを変更した後 (たとえば、FormatException ブロックの最後に意図的に try をスローするなど)、この例を実行して、GetResourceData 呼び出しを使用してリソース情報を取得または再作成する方法を確認できます。