方法 : IConfigurationSectionHandler を使用してカスタム構成セクションを作成する

[アーティクル]
10/22/2014

更新 : 2007 年 11 月

独自の XML 構成要素を使用して、標準の ASP.NET 構成設定のセットを拡張できます。拡張する場合は、独自の構成セクションハンドラを作成する必要があります。

このハンドラは、System.Configuration.IConfigurationSectionHandler インターフェイスまたは System.Configuration.ConfigurationSection クラスを実装した .NET Framework クラスである必要があります。

メモ :
このトピックでは、.NET Framework Version 2.0 から使用されなくなった System.Configuration.IConfigurationSectionHandler インターフェイスを使用します。System.Configuration.ConfigurationSection クラスの使用例については、「方法 : ConfigurationSection を使用してカスタム構成セクションを作成する」を参照してください。以下のコード例を使用する場合は、.NET Framework Version 1.0 または 1.1 でビルドする必要があります。

このトピックでは、.NET Framework Version 2.0 から使用されなくなった System.Configuration.IConfigurationSectionHandler インターフェイスを使用します。System.Configuration.ConfigurationSection クラスの使用例については、「方法 : ConfigurationSection を使用してカスタム構成セクションを作成する」を参照してください。以下のコード例を使用する場合は、.NET Framework Version 1.0 または 1.1 でビルドする必要があります。

セクションハンドラは、Web.config ファイルの特定の部分にある XML 構成要素で定義された設定を解釈して処理し、その構成設定に基づいて適切な構成オブジェクトを返します。ハンドラクラスが返す構成オブジェクトでは、任意のデータ構造を使用できます。このオブジェクトは基本構成クラスや構成形式に限定されません。ASP.NET は構成オブジェクトを使用して、カスタム構成要素の読み取りおよび書き込みを行います。

カスタム構成セクションハンドラを作成するには

次のコードに示すように、System.Configuration.IConfigurationSectionHandler インターフェイスを実装するパブリッククラスを作成します。

Imports System
Imports System.Collections
Imports System.Text
Imports System.Configuration
Imports System.Xml

Namespace MyConfigSectionHandler
  Public Class MyHandler
    Implements IConfigurationSectionHandler

    Public Function Create( _
    ByVal parent As Object, ByVal configContext As Object, ByVal section As System.Xml.XmlNode) _
    As Object Implements System.Configuration.IConfigurationSectionHandler.Create

      Throw New System.Exception("The method is not implemented.")

    End Function
  End Class
End Namespace

using System;
using System.Collections.Generic;
using System.Text;
using System.Configuration;
using System.Xml;

namespace MyConfigSectionHandler
{
  public class MyHandler : IConfigurationSectionHandler
  {
    #region IConfigurationSectionHandler Members

    object IConfigurationSectionHandler.Create(
        object parent, object configContext, XmlNode section)
    {
      throw new Exception("The method is not implemented.");
    }

    #endregion
  }
}

必要な構成作業を実行する、独自のコードを追加します。

たとえば、throw new Exception("The method is not implemented."); の行を、section パラメータの Attributes プロパティから属性名とその値を取得するコードに置き換えることで、カスタム構成オブジェクトを返すことができます。次の例では、Hashtable を構成オブジェクトとして使用しています。

Imports System
Imports System.Collections
Imports System.Text
Imports System.Configuration
Imports System.Xml

Namespace MyConfigSectionHandler

  Public Class MyHandler
    Implements IConfigurationSectionHandler

    Public Function Create( _
    ByVal parent As Object, ByVal configContext As Object, ByVal section As System.Xml.XmlNode) _
    As Object Implements System.Configuration.IConfigurationSectionHandler.Create

      ' Creates the configuration object that this method will return.
      ' This can be a custom configuration class.
      ' In this example, we use a System.Collections.Hashtable.
      Dim myConfigObject As New Hashtable

      ' Gets any attributes for this section element.
      Dim myAttribs As New Hashtable
      For Each attrib As XmlAttribute In section.Attributes
        If XmlNodeType.Attribute = attrib.NodeType Then
          myAttribs.Add(attrib.Name, attrib.Value)
        End If
      Next

      ' Puts the section name and attributes as the first config object item.
      myConfigObject.Add(section.Name, myAttribs)

      ' Gets the child element names and attributes.
      For Each child As XmlNode In section.ChildNodes
        If XmlNodeType.Element = child.NodeType Then
          Dim myChildAttribs As New Hashtable

          For Each childAttrib As XmlAttribute In child.Attributes
            If XmlNodeType.Attribute = childAttrib.NodeType Then
              myChildAttribs.Add(childAttrib.Name, childAttrib.Value)
            End If
          Next
          myConfigObject.Add(child.Name, myChildAttribs)
        End If
      Next

      Return (myConfigObject)

    End Function

  End Class

End Namespace

using System;
using System.Collections;
using System.Text;
using System.Configuration;
using System.Xml;

namespace MyConfigSectionHandler
{
  public class MyHandler : IConfigurationSectionHandler
  {
    #region IConfigurationSectionHandler Members

    object IConfigurationSectionHandler.Create(
      object parent, object configContext, XmlNode section)
    {
      // Creates the configuration object that this method will return.
      // This can be a custom configuration class.
      // In this example, we use a System.Collections.Hashtable.
      Hashtable myConfigObject = new Hashtable();

      // Gets any attributes for this section element.
      Hashtable myAttribs = new Hashtable();
      foreach (XmlAttribute attrib in section.Attributes)
      {
        if (XmlNodeType.Attribute == attrib.NodeType)
          myAttribs.Add(attrib.Name, attrib.Value);
      }

      // Puts the section name and attributes as the first config object item.
      myConfigObject.Add(section.Name, myAttribs);

      // Gets the child element names and attributes.
      foreach (XmlNode child in section.ChildNodes)
      {
        if (XmlNodeType.Element == child.NodeType)
        {
          Hashtable myChildAttribs = new Hashtable();

          foreach (XmlAttribute childAttrib in child.Attributes)
          {
            if (XmlNodeType.Attribute == childAttrib.NodeType)
              myChildAttribs.Add(childAttrib.Name, childAttrib.Value);
          }
          myConfigObject.Add(child.Name, myChildAttribs);
        }
      }

      return (myConfigObject);
    }
    #endregion
  }
}

ASP.NET 構成ファイルにカスタムセクションハンドラを追加するには

次のコードに示すように、configSections 要素内の Web.config ファイルに、sectionGroup と section 要素を追加します。

メモ :

sectionGroup の section 要素を入れ子にすることはオプションですが、構成データの編成に役立つため、お勧めします。

セクションハンドラ宣言は、カスタム構成要素を追加する構成ファイルとは異なる構成ファイルに追加できます。ただし、その場合は、セクションハンドラが宣言される構成ファイルの方が構成ファイル階層で上位にある必要があります。詳細については、「ASP.NET 構成ファイルの階層と継承」を参照してください。

section 要素の type 属性は、アセンブリのマニフェストに一致する必要があり、一致しなければ構成エラーが発生します。アセンブリファイル自体は、これを定義する Web.config ファイルと同じ ASP.NET アプリケーションディレクトリ内に格納されている必要があります。
```
<configuration>


  <configSections>
    <sectionGroup name="myCustomGroup">
      <section 
        name="myCustomSection" 
        type="MyConfigSectionHandler.MyHandler, MyCustomConfigurationHandler, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" 
        allowLocation="true" 
        allowDefinition="Everywhere"
      />
    </sectionGroup>
      
  </configSections>

  

</configuration>
```

メモ :
sectionGroup の section 要素を入れ子にすることはオプションですが、構成データの編成に役立つため、お勧めします。

カスタム構成要素を、Web.config ファイルの構成セクション設定領域に追加します。

<configuration>

<!-- Configuration section-handler declaration area. -->

  <!-- Configuration section settings area. -->
  <myCustomGroup>
    <myCustomSection myAttrib1="Clowns">
      <myChildSection 
          myChildAttrib1="Zippy" 
          myChildAttrib2="Michael Zawondy "/>
    </myCustomSection>
  </myCustomGroup>

  <!-- Other configuration settings, like <system.web> -->

</configuration>

プログラムによりカスタム構成データにアクセスするには

カスタム構成オブジェクトのインスタンスを取得し、ConfigurationManager.GetSection メソッドまたは WebConfigurationManager.GetSection メソッドを使用してインスタンスを設定します。

次の ASPX ページ例では、前の例と連動して、ボタンがクリックされるとカスタム構成セクションの属性および子要素を列挙します。

カスタムセクションハンドラは Hashtable を構成オブジェクトとして使用するため、GetSection メソッドは Hashtable を返します。

次のコードは .aspx ページ内に入ります。分離コードファイルに入るボタンクリックイベント用のコードが、次のコード例に含まれています。

次のコード例には、.NET Framework Version 1.0 または 1.1 が必要です。

<%@ Page language="c#" Codebehind="WebForm1.aspx.cs" AutoEventWireup="false" Inherits="BugTest.WebForm1" %>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" > 

<html>
  <head>
    <title>WebForm1</title>
    <meta name="GENERATOR" 
          Content="Microsoft Visual Studio .NET 2003">
    <meta name="CODE_LANGUAGE" Content="C#">
    <meta name=vs_defaultClientScript content="JavaScript">
    <meta name=vs_targetSchema 
          content="https://schemas.microsoft.com/intellisense/ie5">
  </head>
  <body MS_POSITIONING="GridLayout">
    <form id="Form1" method="post" runat="server">
    <h1>Enumerate MyCustomSection</h1>
    <asp:Label ID="Label1" runat="server" 
        Text="" />
    <br />
    <asp:Button ID="Button1" runat="server" 
        Text="Get Custom Config Info" 
        OnClick="Button1_Click" />
    </form>
  </body>
</html>

<%@ Page Language="vb" AutoEventWireup="false" Codebehind="WebForm1.aspx.vb" Inherits="WebApplication1.WebForm1"%>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" >
<HTML>
  <HEAD>
    <title>WebForm1</title>
    <meta name="GENERATOR" Content="Microsoft Visual Studio .NET 2003">
    <meta name="CODE_LANGUAGE" Content="VB">
    <meta name="vs_defaultClientScript" content="JavaScript">
    <meta name="vs_targetSchema" content="https://schemas.microsoft.com/intellisense/ie5">
  </HEAD>
  <body MS_POSITIONING="GridLayout">
    <form id="Form1" method="post" runat="server">
      <h1>Enumerate MyCustomSection</h1>
      <asp:Label ID="Label1" runat="server" Text="" />
      <br>
      <asp:Button ID="Button1" runat="server" Text="Get Custom Config Info" OnClick="Button1_Click" />
    </form>
  </body>
</HTML>

ボタンクリックイベント用の次のコードは、上記の .aspx ページに属する分離コードファイル内に入ります。分離コードファイルは、@Page 宣言の language 属性に従って .aspx.cs または .aspx.vb のファイル名拡張子を使用します。

[C#]

using System;
using System.Collections;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Web;
using System.Web.SessionState;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.HtmlControls;
using System.Configuration;
using System.Text;

namespace BugTest
{
    /// <summary>
    /// Summary description for WebForm1.
    /// </summary>
    public class WebForm1 : System.Web.UI.Page
    {
        protected System.Web.UI.WebControls.Label Label1;
        protected System.Web.UI.WebControls.Button Button1;

        private void Page_Load(object sender, System.EventArgs e)
        {
            // Put user code to initialize the page here
        }

        #region Web Form Designer generated code
        override protected void OnInit(EventArgs e)
        {
            //
            // CODEGEN: This call is required by the ASP.NET Web Form Designer.
            //
            InitializeComponent();
            base.OnInit(e);
        }

        /// <summary>
        /// Required method for Designer support - do not modify
        /// the contents of this method with the code editor.
        /// </summary>
        private void InitializeComponent()
        {    
            this.Button1.Click += new System.EventHandler(this.Button1_Click);
            this.Load += new System.EventHandler(this.Page_Load);

        }
        #endregion

        protected void Button1_Click(object sender, System.EventArgs e)
        {
            Hashtable config = 
(Hashtable)System.Configuration.ConfigurationSettings.GetConfig("myCustomGroup/myCustomSection");

            StringBuilder sb = new StringBuilder();
            sb.AppendFormat("Config object item count = {0}<br/><br/>", config.Count);
            foreach (DictionaryEntry deKey in config)
            {
                sb.AppendFormat("<h2>Attributes in the {0} Element:</h2>", 
                    deKey.Key.ToString());
                Hashtable attribs = (Hashtable)deKey.Value;
                foreach (DictionaryEntry deAttrib in attribs)
                {
                    sb.AppendFormat("{0} = {1}<br/>", 
                        deAttrib.Key.ToString(), deAttrib.Value.ToString());
                }
            }
            Label1.Text = sb.ToString();
            Label1.Visible = true;

        }
    }
}

Imports System.Text

Public Class WebForm1
  Inherits System.Web.UI.Page

#Region " Web Form Designer Generated Code "

  'This call is required by the Web Form Designer.
  <System.Diagnostics.DebuggerStepThrough()> Private Sub InitializeComponent()

  End Sub
  Protected WithEvents Label1 As System.Web.UI.WebControls.Label
  Protected WithEvents Button1 As System.Web.UI.WebControls.Button

  'NOTE: The following placeholder declaration is required by 
  ' the Web Form Designer.
  'Do not delete or move it.
  Private designerPlaceholderDeclaration As System.Object

  Private Sub Page_Init(ByVal sender As System.Object, ByVal _
e As System.EventArgs) Handles MyBase.Init
    'CODEGEN: This method call is required by the Web Form Designer
    'Do not modify it using the code editor.
    InitializeComponent()
  End Sub

#End Region

  Private Sub Page_Load(ByVal sender As System.Object, ByVal _
e As System.EventArgs) Handles MyBase.Load
    'Put user code to initialize the page here
  End Sub

  Protected Sub Button1_Click(ByVal sender As System.Object, ByVal _
e As System.EventArgs) Handles Button1.Click
    Dim config As Hashtable = _
System.Configuration.ConfigurationSettings.GetConfig( _
"myCustomGroup/myCustomSection")

    Dim sb As New StringBuilder
    sb.AppendFormat("Config object item count = {0}<br/><br/>", _
config.Count)

    For Each deKey As DictionaryEntry In config
      sb.AppendFormat("<h2>Attributes in the {0} Element:</h2>", _
deKey.Key.ToString())
      Dim attribs As Hashtable = deKey.Value
      For Each deAttrib As DictionaryEntry In attribs
        sb.AppendFormat("{0} = {1}<br/>", deAttrib.Key.ToString(), _
deAttrib.Value.ToString())
      Next
      Label1.Text = sb.ToString()
      Label1.Visible = True
    Next

  End Sub
End Class

参照

次の方法で共有

方法 : IConfigurationSectionHandler を使用してカスタム構成セクションを作成する

カスタム構成セクションハンドラを作成するには

ASP.NET 構成ファイルにカスタムセクションハンドラを追加するには

プログラムによりカスタム構成データにアクセスするには

参照

処理手順

概念

その他の技術情報

その他のリソース

次の方法で共有

方法 : IConfigurationSectionHandler を使用してカスタム構成セクションを作成する

カスタム構成セクション ハンドラを作成するには

ASP.NET 構成ファイルにカスタム セクション ハンドラを追加するには

プログラムによりカスタム構成データにアクセスするには

参照

処理手順

概念

その他の技術情報

その他のリソース

カスタム構成セクションハンドラを作成するには

ASP.NET 構成ファイルにカスタムセクションハンドラを追加するには