SharePoint ソリューションのローカライズ

[アーティクル]
08/09/2011

アプリケーションを世界中で使用できるように準備するプロセスをローカライズと呼びます。ローカライズでは、リソースを特定のカルチャに翻訳します。詳細については、「アプリケーションのグローバライズとローカライズ」を参照してください。このトピックでは、SharePoint ソリューションをローカライズする方法の概要について説明します。

ソリューションをローカライズするには、ハードコーディングされた文字列をコードから削除してリソースファイルに抽出します。リソースファイルとは、.resx 拡張子を持つ XML ベースのファイルです。リソースファイルには、ソリューションで使用される文字列の翻訳されたバージョンが含まれています。詳細については、「Resources in Applications (アプリケーションのリソース)」を参照してください。

注意

SharePoint ソリューションのリソースファイルに追加するのは文字列リソースだけです。リソースエディターでは文字列以外のリソースも追加できますが、文字列以外のリソースは SharePoint に配置されません。

リソースファイル

リソースファイルには、既定のリソースファイル、言語に依存しないリソースファイル、および言語固有のリソースファイルの 3 種類があります。

リソースファイルの種類	説明
既定値	フォールバックリソースとも呼ばれます。既定のリソースファイルには、既定のカルチャ (英語など) にローカライズされた文字列が含まれます。これらは、指定された言語のローカライズされたリソースファイルが見つからない場合に使用されます。既定のリソースは、独立したファイルを持たず、メインアプリケーションアセンブリに格納されます。
言語に依存しないリソースファイル	特定の言語にはローカライズされているが特定のカルチャにはローカライズされていない文字列を含むリソースファイル (たとえば、フランス語の場合は "fr")。
言語固有のリソースファイル	特定の言語とカルチャにローカライズされた文字列を含むリソースファイル (たとえば、フランス語 (カナダ) の場合は "fr-CA")。

詳細については、「ローカリゼーション用リソースの階層編成」を参照してください。

Visual Studio SharePoint プロジェクトで既定のリソースファイルを指定するには、リソースファイルを追加するときに、[リソースの追加] ダイアログボックスのカルチャの一覧で [インバリアント言語 (Invariant 国)] を選択します。

Visual Studio SharePoint ソリューションのローカライズ

ソリューションをローカライズする際には、そのソリューションでユーザーに表示されるすべてのテキスト情報を考慮に入れる必要があります。たとえば、情報メッセージ、エラーメッセージ、および UI 文字列を翻訳して、リソースファイルに配置する必要があります。

リソースファイルでは、すべての文字列に一意の識別子があります。翻訳した文字列に対しては、各リソースファイルで同じ識別子を使用する必要があります。たとえば、既定のリソースファイルの最初の文字列の識別子が "String1" だった場合は、言語固有のリソースファイルの最初の文字列の識別子も "String1" にします。

Visual Studio SharePoint アプリケーションでは、フィーチャー、ASPX ページマークアップ、およびコードの 3 つの領域をローカライズするのが一般的です。以降の説明では、SharePoint ソリューションをドイツ語と日本語にローカライズする場合を想定しています。既定の言語は英語です。

フィーチャーのローカライズ

フィーチャーをローカライズするには、ハードコーディングされたフィーチャーのタイトルと説明を、ローカライズされたリソースファイルに含まれている翻訳済みのタイトルと文字列を参照する式に置き換える必要があります。この変更は、Visual Studio のフィーチャーデザイナーで行います。詳細については、「方法: フィーチャーをローカライズする」を参照してください。

英語のフィーチャーをドイツ語と日本語にローカライズするには、プロジェクトに 3 つのリソースファイルプロジェクト項目 (英語用、ドイツ語用、および日本語用) を追加します。フィーチャーリソースファイルは、ASPX マークアップやコードのローカライズには使用できません。これらにはまた別のリソースファイルが必要です。

フィーチャーリソースファイルを作成したら、そこに翻訳済みの文字列を追加します。ローカライズされた文字列にアクセスするには次の形式の式を使用します。

$Resources:String ID

Visual Studio のフィーチャーリソースの名前は常に Resources です。インバリアント言語以外の言語を選択した場合は、リソースファイル名にカルチャ ID が追加されます。たとえば、インバリアント言語 (既定) のフィーチャーリソースファイルを追加した場合は Resources.resx になります。日本語 (日本) のカルチャを選択して言語固有のフィーチャーリソースを追加した場合は名前が Resources.ja-JP.resx になります。フィーチャーリソースファイルの名前は自動的に割り当てられ、変更することはできません。

フィーチャーリソースのスコープは、追加先のフィーチャーのローカルスコープです。ソリューション内の任意のフィーチャーファイルや要素ファイルで使用できるリソースを作成するには、フィーチャーリソースファイルではなく [グローバルリソースファイル] プロジェクト項目を追加します。 [グローバルリソースファイル] プロジェクト項目は、[新しい項目の追加] ダイアログボックスの [SharePoint] の下の [2010] フォルダーにあります。グローバルリソースファイルは、SharePoint ルートフォルダーの \Resources フォルダーに配置されます。

詳細については、「チュートリアル: Visual Studio SharePoint アプリケーションのローカライズ」を参照してください。

ASPX ページマークアップのローカライズ

ASP.NET ページをローカライズするには、プロジェクトに 3 つのリソースファイルプロジェクト項目 (英語用、ドイツ語用、および日本語用) を追加します。マークアップに加えてコードをローカライズする必要がない場合は、代わりにグローバルリソースファイルを追加できます。

既定の言語のリソースファイルに任意の名前を付けます。ローカライズされたリソースファイルに対しては、同じ名前に言語固有のカルチャ ID を加えた名前を使用します (ドイツ語の場合は MyAppResources.de-DE.resx、日本語の場合は MyAppResources.ja-JP.resx など)。

各リソースファイルの [配置タイプ] プロパティを [AppGlobalResource] に設定します。これにより、リソースファイルが App_GlobalResources フォルダーに配置されます。このフォルダーに配置されたリソースファイルは、ソリューション内のすべての ASPX ページと ASPX コントロールで使用できます。 App_GlobalResources フォルダーは、C:\inetpub\wwwroot\wss\VirtualDirectories\<port number>\App_GlobalResources にあります。

注意

グローバルではないリソースファイルを使用する場合は、それらをプロジェクト項目フォルダーに移動します。これにより、[配置タイプ] プロパティやその他の SharePoint 固有のプロパティを使用できるようになります。

ASPX マークアップリソースファイルは、コードのローカライズにも使用できます。リソースを ASPX マークアップだけでなくコードのローカライズにも使用する場合は、各ファイルの [ビルドアクション] プロパティの設定を [埋め込まれたリソース] のままにして、リソースがサテライトアセンブリにコンパイルされるようにします。リソースファイルをマークアップのローカライズのみに使用する場合は、[ビルドアクション] プロパティを [コンテンツ] に変更して、ファイルがメインアプリケーションアセンブリにコンパイルされないようにすることもできます。

ASPX ページと ASPX コントロールのマークアップで、ハードコーディングされたプロパティ文字列をすべて次の形式の式に置き換えます。

<asp:<class> runat="server" Text="<%$Resources:<Resource File Name>, <String ID>%>" />

次に例を示します。

<asp:Button ID="btn1" runat="server" onclick="btn1_Click" Text="<%$Resources:Resource1,String7%>"></asp:Button>

テキストとしての ASPX に対しては次の形式の式を使用します。

<asp:literal ID="<ID>" runat="server" Text="<%$Resources:<Resource File Name>, <String ID>%>" />

次に例を示します。

<asp:literal ID="Literal1" runat="server" Text="<%$Resources:Resource1, String9%>" />

詳細については、「方法: ASPX マークアップをローカライズする」および「チュートリアル: Visual Studio SharePoint アプリケーションのローカライズ」を参照してください。

コードのローカライズ

フィーチャーの文字列と ASP.NET のマークアップに加えて、ソリューションコード内のメッセージ文字列やエラー文字列をローカライズする必要もあります。ローカライズされた情報メッセージやエラーメッセージはサテライトアセンブリに格納されます。サテライトアセンブリには、UI テキストや、例外のような出力メッセージなど、ユーザーに表示される文字列が含まれています。

Visual Studio では、.NET Framework の標準のハブアンドスポークモデルが使用されており、ハブ (メインプログラムアセンブリ) に既定の言語リソースが含まれ、スポーク (サテライトアセンブリ) に言語固有のリソースが含まれます。詳細については、「Packaging and Deploying Resources (リソースのパッケージ化と配置)」を参照してください。サテライトアセンブリはリソース (.resx) ファイルからコンパイルされます。プロジェクトとソリューションパッケージに言語固有のリソースファイルを追加すると、それらのリソースファイルが Visual Studio によって Project Name.resources.dll という名前のサテライトアセンブリにコンパイルされます。

SharePoint アプリケーションのコードをローカライズするには、ASPX マークアップの場合と同様に、既定の言語用と各ローカライズ言語用の個別のリソースファイルプロジェクト項目をプロジェクトに追加します。ただし、前述のとおり、ASPX マークアップのローカライズ用のリソースファイルが既にある場合は、それらをコードのローカライズに再利用できます。リソースファイルを作成する必要がある場合は、.resx 拡張子が付いた任意の名前を既定の言語のリソースファイルに付けます。ローカライズされたリソースファイルに対しては、同じ名前に言語固有のカルチャ ID を加えた名前を使用します。各リソースファイルの [ビルドアクション] プロパティを [埋め込まれたリソース] に設定して、サテライトリソースアセンブリが作成されるようにします。

サテライトアセンブリを作成するには、プロジェクトをビルドした後、パッケージデザイナーの [詳細設定] タブでファイルを追加のアセンブリとして追加します。アセンブリを追加する際には、場所のパスの先頭にカルチャ ID のフォルダーを追加します (de-DE\Project Item Name.resources.dll など)。これにより、同じ名前の複数のファイルをパッケージに含めることができます。

コードで次の構文を使用して、ハードコーディングされた文字列を GetGlobalResourceObject メソッドの呼び出しに置き換えます。

HttpContext.GetGlobalResourceObject("<Resource File Name>", "<String ID>")

詳細については、「方法: コードをローカライズする」および「チュートリアル: Visual Studio SharePoint アプリケーションのローカライズ」を参照してください。

Web パーツコードのローカライズ

Web パーツに含まれるカスタムプロパティエディター機能には、ハードコーディングされた文字列を使用するコード属性 (WebDisplayName、Category、WebDescription など) が含まれています。これらの属性の文字列値を置き換えるには、属性のクラスから派生する別のクラスを作成して、それらのクラスで属性のプロパティを設定します。属性のプロパティは基本クラスに依存します。たとえば、WebDisplayName 属性のプロパティは DisplayNameValue で、WebDescription 属性のプロパティは DescriptionValue です。

派生クラスで、リソースファイルの文字列 ID と ResourceManager オブジェクトを参照してその文字列 ID のローカライズされた値を取得し、その値をプロパティエディターの属性に返します。詳細については、「チュートリアル: Visual Studio SharePoint アプリケーションのローカライズ」を参照してください。