.NET アプリ用のリソース ファイルを作成する
リソース ファイルにリソース (文字列、イメージ、オブジェクト データなど) を追加して、アプリケーションで簡単に使用できるようにすることが可能です。 .NET Framework では、次の 5 つの方法でリソース ファイルを作成できます。
文字列リソースを格納するテキスト ファイルを作成します。 リソース ファイル ジェネレーター (resgen.exe) を使用すると、テキスト ファイルをバイナリ リソース (.resources) ファイルに変換できます。 次に、そのバイナリ リソース ファイルを、言語コンパイラを使用してアプリケーションの実行可能ファイルまたはアプリケーション ライブラリに埋め込むか、アセンブリ リンカー (Al.exe) を使用してサテライト アセンブリに埋め込むことができます。 詳細については、「テキスト ファイル内のリソース」を参照してください。
文字列、イメージ、またはオブジェクト データを格納する XML リソース (.resx) ファイルを作成します。 リソース ファイル ジェネレーター (resgen.exe) を使用すると、.resx ファイルをバイナリ リソース (.resources) ファイルに変換できます。 次に、そのバイナリ リソース ファイルを、言語コンパイラを使用してアプリケーションの実行可能ファイルまたはアプリケーション ライブラリに埋め込むか、アセンブリ リンカー (Al.exe) を使用してサテライト アセンブリに埋め込むことができます。 詳細については、「.resx ファイル内のリソース」を参照してください。
System.Resources 名前空間の型を使用して、XML リソース (.resx) ファイルをプログラムによって作成します。 .resx ファイルを作成し、そのリソースを列挙して、特定のリソースを名前で取得することができます。 詳細については、「プログラムによる .resx ファイルの使用」を参照してください。
バイナリ リソース (.resources) ファイルをプログラムによって作成します。 次に、そのファイルを、言語コンパイラを使用してアプリケーションの実行可能ファイルまたはアプリケーション ライブラリに埋め込むか、アセンブリ リンカー (Al.exe) を使用してサテライト アセンブリに埋め込むことができます。 詳細については、「.resources ファイル内のリソース」を参照してください。
Visual Studio を使用してリソース ファイルを作成し、そのファイルをプロジェクトに追加します。 Visual Studio には、リソースを追加、削除、および変更するためのリソース エディターがあります。 コンパイル時には、リソース ファイルが自動的にバイナリ .resources ファイルに変換されて、アプリケーション アセンブリまたはサテライト アセンブリに埋め込まれます。 詳細については、「Visual Studio のリソース ファイル」を参照してください。
テキスト ファイル内のリソース
テキスト (.txt または .restext) ファイルを使用して格納できるのは、文字列リソースのみです。 文字列以外のリソースの場合は、.resx ファイルを使用するか、またはプログラムで作成します。 文字列リソースを格納するテキスト ファイルの形式は次のとおりです。
# This is an optional comment.
name = value
; This is another optional comment.
name = value
; The following supports conditional compilation if X is defined.
#ifdef X
name1=value1
name2=value2
#endif
# The following supports conditional compilation if Y is undefined.
#if !Y
name1=value1
name2=value2
#endif
.txt ファイルと .restext ファイルのリソース ファイル形式は同じです。 .restext ファイル拡張子は、テキスト ファイルがテキスト ベースのリソース ファイルであることをすぐに識別するために使用します。
文字列リソースは、name/value のペアとして表示されます。ここで、name はリソースを識別する文字列です。value は、リソース取得メソッド (ResourceManager.GetString など) に name を渡すときに返されるリソース文字列です。 name と value は等号 (=) で区切る必要があります。 次に例を示します。
FileMenuName=File
EditMenuName=Edit
ViewMenuName=View
HelpMenuName=Help
注意事項
パスワード、セキュリティの配慮が必要な情報、プライベートなデータなどの格納には、リソース ファイルを使用しないでください。
空の文字列 (つまり、値が String.Empty であるリソース) はテキスト ファイルで使用できます。 次に例を示します。
EmptyString=
.NET Framework 4.5 以降および .NET Core のすべてのバージョンでは、#ifdefsymbol... #endif および #if !symbol... #endif コンストラクトを使用した条件付きコンパイルが、テキスト ファイルでサポートされています。 次に、/define スイッチとリソース ファイル ジェネレーター (resgen.exe) を使用して、シンボルを定義できます。 各リソースには、独自の #ifdefsymbol... #endif または #if !symbol... #endif コンストラクトが必要です。 #ifdef ステートメントを使用した場合、シンボルを定義した場合に関連付けられたリソースが .resources ファイルに追加されます。定義していない場合は追加されません。 #if ! ステートメントを使用した場合、シンボルを定義していない場合に関連付けられたリソースが .resources ファイルに追加されます。定義した場合は追加されません。
テキスト ファイルでは、コメントはオプションです。コメントの行頭にはセミコロン (;) またはシャープ記号 (#) が付きます。 コメントの行はファイル内の任意の場所に配置できます。 リソース ファイル ジェネレーター (resgen.exe) を使用して作成されたコンパイル済みの .resources ファイルにはコメントが含まれません。
テキスト ファイル内の空白行はすべて空白と見なされて無視されます。
次の例では、OKButton および CancelButton という名前の 2 つの文字列リソースを定義します。
#Define resources for buttons in the user interface.
OKButton=OK
CancelButton=Cancel
テキスト ファイルに name が重複して出現する場合、リソース ファイル ジェネレーター (resgen.exe) によって警告が表示され、2 番目の名前が無視されます。
value に改行文字を含めることはできませんが、C 言語形式のエスケープ文字で、改行を表す \n やタブを表す \t は使用できます。エスケープする場合は、円記号を含めることができます (たとえば、"\\")。 空の文字列を使用することもできます。
リトル エンディアンまたはビッグ エンディアンのバイト順の UTF-8 エンコードまたは UTF-16 エンコードを使用して、テキスト ファイル形式でリソースを保存します。 ただし、.txt ファイルを .resources ファイルに変換するリソース ファイル ジェネレーター (resgen.exe) では、ファイルを既定では UTF-8 として扱います。 UTF-16 でエンコードされたファイルを Resgen.exe が認識できるようにする場合は、ファイルの先頭に Unicode バイト順マーク (U+FEFF) を置く必要があります。
テキスト形式のリソース ファイルを .NET アセンブリに埋め込むには、リソース ファイル ジェネレーター (resgen.exe) を使用してファイルをバイナリ リソース (.resources) ファイルに変換する必要があります。 次に、その .resources ファイルを、言語コンパイラを使用して .NET アセンブリに埋め込むか、アセンブリ リンカー (Al.exe) を使用してサテライト アセンブリに埋め込むことができます。
次の例では、単純な "Hello World" コンソール アプリケーションで、GreetingResources.txt という名前のテキスト形式のリソース ファイルを使用します。 このテキスト ファイルでは、ユーザーに氏名の入力を求め、あいさつ文を表示する 2 つの文字列 (prompt および greeting) を定義します。
# GreetingResources.txt
# A resource file in text format for a "Hello World" application.
#
# Initial prompt to the user.
prompt=Enter your name:
# Format string to display the result.
greeting=Hello, {0}!
このテキスト ファイルは、次のコマンドを使用して .resources ファイルに変換できます。
resgen GreetingResources.txt
次の例は、.resources ファイルを使用してユーザーにメッセージを表示するコンソール アプリケーションのソース コードを示しています。
using System;
using System.Reflection;
using System.Resources;
public class Example
{
public static void Main()
{
ResourceManager rm = new ResourceManager("GreetingResources",
typeof(Example).Assembly);
Console.Write(rm.GetString("prompt"));
string name = Console.ReadLine();
Console.WriteLine(rm.GetString("greeting"), name);
}
}
// The example displays output like the following:
// Enter your name: Wilberforce
// Hello, Wilberforce!
Imports System.Reflection
Imports System.Resources
Module Example
Public Sub Main()
Dim rm As New ResourceManager("GreetingResources",
GetType(Example).Assembly())
Console.Write(rm.GetString("prompt"))
Dim name As String = Console.ReadLine()
Console.WriteLine(rm.GetString("greeting"), name)
End Sub
End Module
' The example displays output like the following:
' Enter your name: Wilberforce
' Hello, Wilberforce!
Visual Basic を使用している場合、ソース コード ファイル名が Greeting.vb であれば、埋め込みの .resources ファイルを含む実行可能ファイルを次のコマンドによって作成します。
vbc greeting.vb -resource:GreetingResources.resources
C# を使用している場合、ソース コード ファイル名が Greeting.cs であれば、埋め込みの .resources ファイルを含む実行可能ファイルを次のコマンドによって作成します。
csc greeting.cs -resource:GreetingResources.resources
.resx ファイル内のリソース
文字列リソースのみの格納が可能なテキスト ファイルとは異なり、XML リソース (.resx) ファイルは文字列、バイナリ データ (イメージ、アイコン、オーディオ クリップなど)、およびプログラム オブジェクトを格納できます。 .resx ファイルには、リソース エントリの形式を説明し、データの解析に使用する XML のバージョン管理情報を示す標準ヘッダーが含まれます。 XML ヘッダーの後に、リソース ファイル データが続きます。 各データ項目は、data タグに含まれる名前と値のペアで構成されます。 name 属性ではリソース名を定義し、入れ子になった value タグにはリソースの値を格納します。 文字列データの場合は、value タグに文字列が格納されます。
たとえば、次の data タグでは、prompt という名前の文字列リソースを定義します。このリソースの値は "Enter your name:" です。
<data name="prompt" xml:space="preserve">
<value>Enter your name:</value>
</data>
警告
パスワード、セキュリティの配慮が必要な情報、プライベートなデータなどの格納には、リソース ファイルを使用しないでください。
リソース オブジェクトの場合は、リソースのデータ型を示す type 属性が data タグに含まれます。 バイナリ データで構成されるオブジェクトの場合、data タグには、バイナリ データの mimetype 型を示す base64 属性も含まれます。
注意
すべての .resx ファイルは、指定された型のバイナリ データを生成し解析するために、バイナリのシリアル化フォーマッタを使用します。 このため、オブジェクトのバイナリ シリアル化形式が互換性のない形式に変更されると、.resx ファイルは無効になる可能性があります。
次の例は、Int32 リソースおよびビットマップ イメージを含む .resx ファイルの一部を示しています。
<data name="i1" type="System.Int32, mscorlib">
<value>20</value>
</data>
<data name="flag" type="System.Drawing.Bitmap, System.Drawing,
Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a"
mimetype="application/x-microsoft.net.object.bytearray.base64">
<value>
AAEAAAD/////AQAAAAAAAAAMAgAAADtTeX…
</value>
</data>
重要
.resx ファイルは定義されている形式の整形式 XML で構成する必要があるため、特に文字列以外のリソースが .resx ファイルに格納されている場合に、.resx ファイルを手動で操作することはお勧めしません。 代わりに、Visual Studio では、.resx ファイルを作成および操作するための透過的なインターフェイスが提供されています。 詳細については、「Visual Studio のリソース ファイル」を参照してください。 .resx ファイルは、プログラムによって作成および操作することもできます。 詳細については、「プログラムによる .resx ファイルの使用」を参照してください。
.resources ファイル内のリソース
System.Resources.ResourceWriter クラスを使用すると、プログラムによってコードから直接、バイナリ リソース (.resources) ファイルを作成できます。 また、リソース ファイル ジェネレーター (resgen.exe) を使用して、テキスト ファイルまたは .resx ファイルから .resources ファイルを作成することもできます。 .resources ファイルには、文字列データに加えて、バイナリ データ (バイト配列) およびオブジェクト データを格納できます。 .resources ファイルをプログラムによって作成するには、次の手順が必要です。
一意のファイル名を付けて ResourceWriter オブジェクトを作成します。 そのためには、ファイル名またはファイル ストリームを ResourceWriter クラス コンストラクターに指定します。
ファイルに追加する名前付きリソースごとに ResourceWriter.AddResource メソッドのオーバーロードの 1 つを呼び出します。 リソースには、文字列、オブジェクト、またはバイナリ データのコレクション (バイト配列) を指定できます。
ResourceWriter.Close メソッドを呼び出してファイルにリソースを書き込み、ResourceWriter オブジェクトを閉じます。
注意
パスワード、セキュリティの配慮が必要な情報、プライベートなデータなどの格納には、リソース ファイルを使用しないでください。
次の例では、6 つの文字列、1 つのアイコン、2 つのアプリケーション定義オブジェクト (2 つの Automobile オブジェクト) を格納する、CarResources.resources という名前の .resources ファイルをプログラムによって作成します。 この例で定義およびインスタンス化される Automobile クラスは、SerializableAttribute 属性でタグ付けされます。これにより、バイナリのシリアル化フォーマッタによってクラスを永続化できます。
using System;
using System.Drawing;
using System.Resources;
[Serializable()] public class Automobile
{
private string carMake;
private string carModel;
private int carYear;
private int carDoors;
private int carCylinders;
public Automobile(string make, string model, int year) :
this(make, model, year, 0, 0)
{ }
public Automobile(string make, string model, int year,
int doors, int cylinders)
{
this.carMake = make;
this.carModel = model;
this.carYear = year;
this.carDoors = doors;
this.carCylinders = cylinders;
}
public string Make {
get { return this.carMake; }
}
public string Model {
get { return this.carModel; }
}
public int Year {
get { return this.carYear; }
}
public int Doors {
get {
return this.carDoors; }
}
public int Cylinders {
get {
return this.carCylinders; }
}
}
public class Example
{
public static void Main()
{
// Instantiate an Automobile object.
Automobile car1 = new Automobile("Ford", "Model N", 1906, 0, 4);
Automobile car2 = new Automobile("Ford", "Model T", 1909, 2, 4);
// Define a resource file named CarResources.resx.
using (ResourceWriter rw = new ResourceWriter(@".\CarResources.resources"))
{
rw.AddResource("Title", "Classic American Cars");
rw.AddResource("HeaderString1", "Make");
rw.AddResource("HeaderString2", "Model");
rw.AddResource("HeaderString3", "Year");
rw.AddResource("HeaderString4", "Doors");
rw.AddResource("HeaderString5", "Cylinders");
rw.AddResource("Information", SystemIcons.Information);
rw.AddResource("EarlyAuto1", car1);
rw.AddResource("EarlyAuto2", car2);
}
}
}
Imports System.Drawing
Imports System.Resources
<Serializable()> Public Class Automobile
Private carMake As String
Private carModel As String
Private carYear As Integer
Private carDoors AS Integer
Private carCylinders As Integer
Public Sub New(make As String, model As String, year As Integer)
Me.New(make, model, year, 0, 0)
End Sub
Public Sub New(make As String, model As String, year As Integer,
doors As Integer, cylinders As Integer)
Me.carMake = make
Me.carModel = model
Me.carYear = year
Me.carDoors = doors
Me.carCylinders = cylinders
End Sub
Public ReadOnly Property Make As String
Get
Return Me.carMake
End Get
End Property
Public ReadOnly Property Model As String
Get
Return Me.carModel
End Get
End Property
Public ReadOnly Property Year As Integer
Get
Return Me.carYear
End Get
End Property
Public ReadOnly Property Doors As Integer
Get
Return Me.carDoors
End Get
End Property
Public ReadOnly Property Cylinders As Integer
Get
Return Me.carCylinders
End Get
End Property
End Class
Module Example
Public Sub Main()
' Instantiate an Automobile object.
Dim car1 As New Automobile("Ford", "Model N", 1906, 0, 4)
Dim car2 As New Automobile("Ford", "Model T", 1909, 2, 4)
' Define a resource file named CarResources.resx.
Using rw As New ResourceWriter(".\CarResources.resources")
rw.AddResource("Title", "Classic American Cars")
rw.AddResource("HeaderString1", "Make")
rw.AddResource("HeaderString2", "Model")
rw.AddResource("HeaderString3", "Year")
rw.AddResource("HeaderString4", "Doors")
rw.AddResource("HeaderString5", "Cylinders")
rw.AddResource("Information", SystemIcons.Information)
rw.AddResource("EarlyAuto1", car1)
rw.AddResource("EarlyAuto2", car2)
End Using
End Sub
End Module
作成した .resources ファイルは、言語コンパイラの /resource スイッチを追加してランタイム実行可能ファイルまたはライブラリに埋め込むか、アセンブリ リンカー (Al.exe) を使用してサテライト アセンブリに埋め込むことができます。
Visual Studio でのリソース ファイル
Visual Studio プロジェクトにリソース ファイルを追加すると、プロジェクト ディレクトリに .resx ファイルが作成されます。 Visual Studio には、文字列、イメージ、およびバイナリ オブジェクトを追加するためのリソース エディターがあります。 このエディターは静的データのみを処理するように設計されているので、プログラム オブジェクトを格納するために使用することはできません。オブジェクト データは、.resx ファイルまたは .resources ファイルにプログラムによって書き込む必要があります。 詳細については、「プログラムによる .resx ファイルの使用」と「.resources ファイル内のリソース」セクションを参照してください。
ローカライズされたリソースを追加する場合は、メイン リソース ファイルと同じルート ファイル名を指定します。 ファイル名内でカルチャを指定する必要もあります。 たとえば、Resources.resx という名前のリソース ファイルを追加する場合に、英語 (米国) とフランス語 (フランス) の各カルチャ用にローカライズされたリソースを保持するには、Resources.en-US.resx および Resources.fr-FR.resx という名前のリソース ファイルを作成します。 また、アプリケーションの既定のカルチャも指定しておく必要があります。 この情報は、特定のカルチャ用にローカライズされたリソースが見つからない場合に、どのカルチャのリソースを使用するか決定するために使用されます。
既定のカルチャを指定するには、Visual Studio のソリューション エクスプローラーで次の手順を実行します。
- プロジェクトのプロパティを開き、プロジェクトを右クリックして [プロパティ] を選択します (または、プロジェクトを選択した状態で Alt + Enter キーを押します)。
- [パッケージ] タブを選択します。
- [全般] 領域で、適切な言語/カルチャを [アセンブリ ニュートラル言語] コントロールから選択します。
- 変更を保存します。
コンパイル時に、Visual Studio ではまずプロジェクト内の .resx ファイルがバイナリ リソース (.resources) ファイルに変換されて、プロジェクトの obj ディレクトリのサブディレクトリに格納されます。 ローカライズされたリソースが格納されていないリソース ファイルは、プロジェクトで生成されたメイン アセンブリに埋め込みます。 ローカライズされたリソースがリソース ファイルに格納されている場合、Visual Studio では、各ローカライズ カルチャの個別のサテライト アセンブリにそのファイルを埋め込みます。 各サテライト アセンブリは、ローカライズ カルチャに対応する名前のディレクトリに格納します。 たとえば、ローカライズされた英語 (米国) リソースは、en-US サブディレクトリ内のサテライト アセンブリに格納されます。
関連項目
.NET
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示