Zenn
🛠️

SharePoint 2013 アプリケーション ページでアセンブリ リソース ファイルを使用する

に公開
SharePoint
tech

はじめに

ASP.NET Web ページでアセンブリ リソース ファイルを使用する場合、以下のフォルダーに resx ファイルを格納します。

  • App_GlobalResources フォルダー
  • App_LocalResources フォルダー

ただし、SharePoint アプリケーション ページの場合は、これらのフォルダーを作成できません。アセンブリ リソース ファイルを利用するには、SharePoint 2013 のマップされた Resources フォルダーに格納します。[1] 読み込む方法も異なるため、手順を順に解説します。

サンプル コード

https://github.com/karamem0/samples/tree/main/sharepoint-farm-solution-with-resource

実行手順

アセンブリ リソース ファイルの追加

空の SharePoint プロジェクトを作成します。ソリューション エクスプローラー から 追加 - SharePoint のマップされたフォルダー を選択します。

SharePoint のマップされたフォルダーの追加 ダイアログで Resources を選択します。

ソリューション エクスプローラー で追加された Resources フォルダーから 追加 - 新しい項目 を選択します。新しい項目の追加 ダイアログで 全般 - リソース ファイル を選択し、追加 をクリックします。

追加した resx ファイルを開き、リソースを追加します。

ApplicationPage1.aspx

新しいアプリケーション ページを作成します。

アセンブリ リソース ファイルの読み込みには SPUtility.GetLocalizedString メソッドを使用します。

<asp:Content id="Main" contentplaceholderid="PlaceHolderMain" runat="server">
    <h1><%# SPUtility.GetLocalizedString("$Resources: Message", "Resource1", SPContext.Current.Web.Language) %></h1>
</asp:Content>

ApplicationPage1.aspx.cs

コード ビハインドでは DataBind を呼び出す必要があります。

public partial class ApplicationPage1 : LayoutsPageBase
{
    protected void Page_Load(object sender, EventArgs e)
    {
        this.DataBind();
    }
}

実行結果

デバッグを実行すると、アプリケーション ページにリソース ファイルで追加したメッセージが表示されます。

おわりに

SPUtility.GetLocalizedString メソッドは、パラメーターとしてロケール ID (LCID) を指定できます。ここでは SPWeb.Language プロパティを設定しています。アセンブリ リソース ファイルを各言語ごとに (たとえば ApplicationPage1.ja-jp.aspx、ApplicationPage1.en-us.aspx など) 用意することで、国際化対応のアプリケーション ページを作成できます。

脚注

  1. 物理パスは %ProgramFiles%\Common Files\Microsoft Shared\Web Server Extensions\15\Resources です。 ↩︎

Discussion