Web.Config ファイルに独自の設定項目を追加する - Web.Configファイルに設定情報を記述する

Web.Config ファイルにASP.NET Webアプリケーションの設定情報を追加する方法を紹介します。

はじめに

ASP.NET Webアプリケーションを作成しているとファイルのパスや、共通のサービス名など共通して設定しておきたい項目や設定項目を一か所にまとめておきたい場合があります。web.configファイルに設定情報を記述しておくことで設定ファイルを一か所にまとめておくことができます。

手順

web.config ファイルへの設定項目の追加

web.configファイルに設定項目を追加します。設定項目は<configuration>の<appSettings>内に記述します。

コード例

<?xml version="1.0"?>
<configuration>
  <appSettings>
    <add key="ServiceName" value="iPentecのWebサービス"/>
  </appSettings>
  
  <system.web>
    <compilation debug="true" targetFramework="4.0">
    </compilation>
    <httpRuntime/>
  </system.web>
</configuration>

解説

<appSettings>内に<add>タグを記述することで、設定項目を追加できます。上記の例では"ServiceName"という名前を持つ設定要素を追加し、値に"iPentecのWebサービス"を設定しています。

設定項目の読み取り

web.configファイルに設定した項目を読み出します。

UIの作成


コード

下記のコードを記述します。
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Configuration;

namespace WebConfigSettings
{
  public partial class Default : System.Web.UI.Page
  {
    protected void Page_Load(object sender, EventArgs e)
    {
      string value = ConfigurationManager.AppSettings["ServiceName"];
      Label1.Text = value;
    }
  }
}

解説

Configurationmanager.AppSettingsプロパティを用いて、Web.Configに設定した値を読み取れます。プロパティの配列添え字には設定キーを与えます。上記コードでは"ServiceName"を与えているため、Web.Configに設定したkey="ServiceName"の値を読み出します。

実行結果

プロジェクトを実行します。Webブラウザが表示され下図が表示されます。Web.Configファイルに設定した値が表示されました。

著者
iPentecのメインプログラマー
C#, ASP.NET の開発がメイン、少し前まではDelphiを愛用
掲載日: 2012-11-26
iPentec all rights reserverd.