🔧

SharePoint 2013 アプリケーション ページで Web.config を使用する

に公開

はじめに

SharePoint 2013 のアプリケーション ページは、空の SharePoint プロジェクト テンプレートから作成します。初期状態ではファイルが存在しませんが、Web.config ファイルを配置可能です。ただし、いくつか注意点があります。

サンプル コード

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

実行手順

Web.config の追加

空の SharePoint プロジェクトを作成し、アプリケーション ページ (ApplicationPage1.aspx) を作成します。ソリューション エクスプローラーで ApplicationPage1.aspx が保存されているフォルダーを右クリックし、追加 - 新しい項目 を選択します。新しい項目の追加 ダイアログでは、通常の ASP.NET アプリケーションで利用できる Web 構成ファイル テンプレートが表示されません。そのため、アプリケーション構成ファイル を選択し、ファイル名を Web.config に変更してください。

作成した Web.config ファイルを次のように編集します。

<?xml version="1.0" encoding="utf-8"?>
<configuration>
    <appSettings>
        <add key="Message" value="Hello SharePoint" />
    </appSettings>
</configuration>

ApplicationPage1.aspx の編集

System.Configuration.dll への参照を追加し、ApplicationPage1.aspx を以下のように編集します。

<%@ Import namespace="System.Configuration" %>
<asp:Content id="Main" contentplaceholderid="PlaceHolderMain" runat="server">
    <h1><%# ConfigurationManager.AppSettings["Message"] %></h1>
</asp:Content>

実行結果

デバッグを開始すると、次のように表示されます。

注意事項

アプリケーション ページの Web.config ファイルは、ASP.NET Web アプリケーションのサブフォルダーに配置されます。そのため、すべての機能 (たとえば HTTP モジュールの登録など) を利用できるわけではありません。ルートの Web.config ファイルは既定で C:\inetpub\wwwroot\wss\VirtualDirectories\{{port-number}} にあります。ルートの Web.config を編集可能ですが、アプリケーション全体に影響を与えるため、十分に注意してください。

Discussion