SiteMapSection

.NET Framework クラス ライブラリ リファレンス

SiteMapSection クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

サイト ナビゲーションを構成、保存、およびレンダリングするためのインフラストラクチャのサポートに使用される構成設定を定義します。このクラスは継承できません。

名前空間: System.Web.Configuration
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public NotInheritable Class
 SiteMapSection
    Inherits ConfigurationSection

Visual Basic (使用法)

Dim instance As SiteMapSection

C#

public sealed class SiteMapSection : ConfigurationSection

C++

public ref class SiteMapSection sealed : public
 ConfigurationSection

J#

public final class SiteMapSection extends ConfigurationSection

JScript

public final class SiteMapSection extends
 ConfigurationSection

解説

SiteMapSection クラスを使用すると、構成ファイルの siteMap セクションの内容にプログラムからアクセスして変更できます。

使用例

この例では、siteMap セクションの複数の属性に対して、宣言によって値を指定する方法を示しています。これらの属性には、SiteMapSection クラスのメンバとしてもアクセスできます。

次の構成ファイルの例では、siteMap セクションに対して、宣言によって値を指定する方法を示しています。

<system.web>
  <siteMap defaultProvider="XmlSiteMapReader" enabled="true">
    <providers>
      <clear />
      <add 
        name="XmlSiteMapReader"
        type="XmlSiteMapProvider, System.Web, Version=1.1.3300.0,
              Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a"
        siteMapFile="my.sitemap" 
        description="XmlSiteMapProvider that loads my.sitemap"/>
  </siteMap>
</system.web>

SiteMapSection クラスを使用する方法を次のコード例に示します。

Visual Basic

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports System.Configuration
Imports System.Web
Imports System.Web.Configuration

Namespace Samples.Aspnet.SystemWebConfiguration
  Class UsingSiteMapSection
    Public Shared Sub Main()
      Try
        ' Set the path of the config file.
        Dim configPath As String
 = ""

        ' Get the Web application configuration object.
        Dim config As System.Configuration.Configuration
 = _
         System.Web.Configuration.WebConfigurationManager.OpenWebConfiguration(configPath)

        ' Get the section related object.
        Dim configSection As System.Web.Configuration.SiteMapSection
 = _
         CType(config.GetSection("system.web/siteMap"),
 _
         System.Web.Configuration.SiteMapSection)

        ' Display title and info.
        Console.WriteLine("ASP.NET Configuration Info")
        Console.WriteLine()

        ' Display Config details.
        Console.WriteLine("File Path: {0}", config.FilePath)
        Console.WriteLine("Section Path: {0}", configSection.SectionInformation.Name)

        ' Display Default Provider.
        Console.WriteLine("Default Provider: {0}",
 _
         configSection.DefaultProvider)

        ' Set Default Provider.
        configSection.DefaultProvider = "SiteMapProviderName"

        ' Display Enabled value.
        Console.WriteLine("Enabled: {0}", configSection.Enabled)

        ' Set Enabled value.
        configSection.Enabled = True

        ' Display the number of Providers
        Console.WriteLine("Providers Collection Count: {0}",
 _
         configSection.Providers.Count)

        ' Display elements of the Providers collection property.
        For Each providerItem As
 ProviderSettings In configSection.Providers()
          Console.WriteLine()
          Console.WriteLine("Provider Details -")
          Console.WriteLine("Name: {0}", providerItem.Name)
          Console.WriteLine("Type: {0}", providerItem.Type)
        Next

        ' Update if not locked.
        If Not configSection.SectionInformation.IsLocked
 Then
          config.Save()
          Console.WriteLine("** Configuration updated.")
        Else
          Console.WriteLine("** Could not update, section is locked.")
        End If

      Catch e As Exception
        ' Unknown error.
        Console.WriteLine(e.ToString())
      End Try

      ' Display and wait
      Console.ReadLine()
    End Sub
  End Class
End Namespace

C#

#region Using directives

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

#endregion

namespace Samples.Aspnet.SystemWebConfiguration
{
  class UsingSiteMapSection
  {
    static void Main(string[]
 args)
    {
      try
      {
        // Set the path of the config file.
        string configPath = "";

        // Get the Web application configuration object.
        Configuration config = WebConfigurationManager.OpenWebConfiguration(configPath);

        // Get the section related object.
        SiteMapSection configSection = 
          (SiteMapSection)config.GetSection("system.web/siteMap");

        // Display title and info.
        Console.WriteLine("ASP.NET Configuration Info");
        Console.WriteLine();

        // Display Config details.
        Console.WriteLine("File Path: {0}", 
          config.FilePath);
        Console.WriteLine("Section Path: {0}",
          configSection.SectionInformation.Name);
        // Display Default Provider.
        Console.WriteLine("Default Provider: {0}",
          configSection.DefaultProvider);

        // Set Default Provider.
        configSection.DefaultProvider = 
          "SiteMapProviderName";

        // Display Enabled value.
        Console.WriteLine("Enabled: {0}", configSection.Enabled);

        // Set Enabled value.
        configSection.Enabled = true;

        // Display the number of Providers
        Console.WriteLine("Providers Collection Count: {0}",
          configSection.Providers.Count);

        // Display elements of the Providers collection property.
        foreach (ProviderSettings providerItem in
 configSection.Providers)
        {
          Console.WriteLine();
          Console.WriteLine("Provider Details:");
          Console.WriteLine("Name: {0}", providerItem.Name);
          Console.WriteLine("Type: {0}", providerItem.Type);
        }

        // Update if not locked.
        if (!configSection.SectionInformation.IsLocked)
        {
          config.Save();
          Console.WriteLine("** Configuration updated.");
        }
        else
        {
          Console.WriteLine("** Could not update, section is locked.");
        }
      }

      catch (Exception e)
      {
        // Unknown error.
        Console.WriteLine(e.ToString());
      }

      // Display and wait
      Console.ReadLine();
    }
  }
}

継承階層

System.Object
   System.Configuration.ConfigurationElement
     System.Configuration.ConfigurationSection
      System.Web.Configuration.SiteMapSection

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
SiteMapSection メンバ
System.Web.Configuration 名前空間
ConfigurationSection
SiteMapPath
SiteMap クラス
その他の技術情報
siteMap 要素 (ASP.NET 設定スキーマ)

SiteMapSection コンストラクタ

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

このコンストラクタは、.NET Framework インフラストラクチャをサポートします。独自に作成したコードから直接使用するためのものではありません。

既定の設定を使用して SiteMapSection クラスの新しいインスタンスを初期化します。

名前空間: System.Web.Configuration
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Sub New

Visual Basic (使用法)

Dim instance As New SiteMapSection

C#

public SiteMapSection ()

C++

public:
SiteMapSection ()

J#

public SiteMapSection ()

JScript

public function SiteMapSection ()

解説

SiteMapSection コンストラクタは、コードで直接使用するためのものではありません。ASP.NET 構成システムによって呼び出されます。SiteMapSection クラスのインスタンスは、GetSection メソッドを使用して取得します。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
SiteMapSection クラス
SiteMapSection メンバ
System.Web.Configuration 名前空間

SiteMapSection プロパティ

パブリック プロパティ

( プロテクト プロパティ も参照)

	名前	説明
	DefaultProvider	既定のナビゲーション プロバイダの名前を取得または設定します。
	ElementInformation	ConfigurationElement オブジェクトのカスタマイズできない情報と機能を格納する ElementInformation オブジェクトを取得します。 ( ConfigurationElement から継承されます。)
	Enabled	ASP.NET のサイト マップ機能が有効かどうかを示す値を取得または設定します。
	LockAllAttributesExcept	ロックされている属性のコレクションを取得します。 ( ConfigurationElement から継承されます。)
	LockAllElementsExcept	ロックされている要素のコレクションを取得します。 ( ConfigurationElement から継承されます。)
	LockAttributes	ロックされている属性のコレクションを取得します。 ( ConfigurationElement から継承されます。)
	LockElements	ロックされている要素のコレクションを取得します。 ( ConfigurationElement から継承されます。)
	LockItem	要素がロックされているかどうかを示す値を取得または設定します。 ( ConfigurationElement から継承されます。)
	Providers	ProviderSettings オブジェクトの ProviderSettingsCollection コレクションを取得します。
	SectionInformation	ConfigurationSection オブジェクトのカスタマイズできない情報と機能を格納する SectionInformation オブジェクトを取得します。 ( ConfigurationSection から継承されます。)

プロテクト プロパティ

	名前	説明
	ElementProperty	ConfigurationElement オブジェクト自体を表す ConfigurationElementProperty オブジェクトを取得します。 ( ConfigurationElement から継承されます。)
	EvaluationContext	ConfigurationElement オブジェクトの ContextInformation オブジェクトを取得します。 ( ConfigurationElement から継承されます。)
	Item	オーバーロードされます。 この ConfigurationElement オブジェクトのプロパティ、属性、または子要素を取得または設定します。 ( ConfigurationElement から継承されます。)
	Properties	プロパティのコレクションを取得します。 ( ConfigurationElement から継承されます。)

参照

関連項目

SiteMapSection クラス
System.Web.Configuration 名前空間
ConfigurationSection
SiteMapPath
SiteMap クラス

その他の技術情報

siteMap 要素 (ASP.NET 設定スキーマ)

SiteMapSection メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 現在の ConfigurationElement インスタンスを、指定したオブジェクトと比較します。 ( ConfigurationElement から継承されます。)
	GetHashCode	現在の ConfigurationElement インスタンスを表す一意の値を取得します。 ( ConfigurationElement から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	IsReadOnly	ConfigurationElement オブジェクトが読み取り専用かどうかを示す値を取得します。 ( ConfigurationElement から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	DeserializeElement	構成ファイルから XML を読み取ります。 ( ConfigurationElement から継承されます。)
	DeserializeSection	構成ファイルから XML を読み取ります。 ( ConfigurationSection から継承されます。)
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	GetRuntimeObject	派生クラスでオーバーライドされると、カスタム オブジェクトを返します。 ( ConfigurationSection から継承されます。)
	Init	ConfigurationElement オブジェクトを初期状態に設定します。 ( ConfigurationElement から継承されます。)
	InitializeDefault	ConfigurationElement オブジェクトの既定の値セットを初期化するために使用します。 ( ConfigurationElement から継承されます。)
	IsModified	派生クラスに実装された場合、この構成要素が最後の保存または読み込み以降に変更されたかどうかを示します。 ( ConfigurationSection から継承されます。)
	ListErrors	この ConfigurationElement オブジェクトおよびすべてのサブ要素の無効なプロパティのエラーを、渡されたリストに追加します。 ( ConfigurationElement から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)
	OnDeserializeUnrecognizedAttribute	逆シリカル化中に不明な属性が発生したかどうかを示す値を取得します。 ( ConfigurationElement から継承されます。)
	OnDeserializeUnrecognizedElement	逆シリカル化中に不明な要素が発生したかどうかを示す値を取得します。 ( ConfigurationElement から継承されます。)
	OnRequiredPropertyNotFound	必須プロパティが見つからなかったかどうかを示す値を取得します。 ( ConfigurationElement から継承されます。)
	PostDeserialize	逆シリアル化後に呼び出されます。 ( ConfigurationElement から継承されます。)
	PreSerialize	シリアル化前に呼び出されます。 ( ConfigurationElement から継承されます。)
	Reset	ConfigurationElement オブジェクトの内部状態 (ロックやプロパティ コレクションなど) をリセットします。 ( ConfigurationElement から継承されます。)
	ResetModified	派生クラスに実装された場合、IsModified メソッドの値を false にリセットします。 ( ConfigurationSection から継承されます。)
	SerializeElement	派生クラスに実装されている場合、この構成要素の内容を構成ファイルに書き込みます。 ( ConfigurationElement から継承されます。)
	SerializeSection	ファイルに書き込む 1 つのセクションとして、ConfigurationSection オブジェクトのアンマージされたビューを含む XML 文字列を作成します。 ( ConfigurationSection から継承されます。)
	SerializeToXmlElement	派生クラスに実装されている場合、この構成要素の外側のタグを構成ファイルに書き込みます。 ( ConfigurationElement から継承されます。)
	SetPropertyValue	プロパティを指定した値に設定します。 ( ConfigurationElement から継承されます。)
	SetReadOnly	ConfigurationElement オブジェクトおよびすべてのサブ要素に IsReadOnly プロパティを設定します。 ( ConfigurationElement から継承されます。)
	Unmerge	保存しないすべての値を削除するには、ConfigurationElement オブジェクトを変更します。 ( ConfigurationElement から継承されます。)

参照

関連項目

SiteMapSection クラス
System.Web.Configuration 名前空間
ConfigurationSection
SiteMapPath
SiteMap クラス

その他の技術情報

siteMap 要素 (ASP.NET 設定スキーマ)

SiteMapSection メンバ

サイト ナビゲーションを構成、保存、およびレンダリングするためのインフラストラクチャのサポートに使用される構成設定を定義します。このクラスは継承できません。

SiteMapSection データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	SiteMapSection	既定の設定を使用して SiteMapSection クラスの新しいインスタンスを初期化します。

パブリック プロパティ

( プロテクト プロパティ も参照)

	名前	説明
	DefaultProvider	既定のナビゲーション プロバイダの名前を取得または設定します。
	ElementInformation	ConfigurationElement オブジェクトのカスタマイズできない情報と機能を格納する ElementInformation オブジェクトを取得します。 (ConfigurationElement から継承されます。)
	Enabled	ASP.NET のサイト マップ機能が有効かどうかを示す値を取得または設定します。
	LockAllAttributesExcept	ロックされている属性のコレクションを取得します。(ConfigurationElement から継承されます。)
	LockAllElementsExcept	ロックされている要素のコレクションを取得します。(ConfigurationElement から継承されます。)
	LockAttributes	ロックされている属性のコレクションを取得します。 (ConfigurationElement から継承されます。)
	LockElements	ロックされている要素のコレクションを取得します。(ConfigurationElement から継承されます。)
	LockItem	要素がロックされているかどうかを示す値を取得または設定します。(ConfigurationElement から継承されます。)
	Providers	ProviderSettings オブジェクトの ProviderSettingsCollection コレクションを取得します。
	SectionInformation	ConfigurationSection オブジェクトのカスタマイズできない情報と機能を格納する SectionInformation オブジェクトを取得します。 (ConfigurationSection から継承されます。)

プロテクト プロパティ

	名前	説明
	ElementProperty	ConfigurationElement オブジェクト自体を表す ConfigurationElementProperty オブジェクトを取得します。(ConfigurationElement から継承されます。)
	EvaluationContext	ConfigurationElement オブジェクトの ContextInformation オブジェクトを取得します。(ConfigurationElement から継承されます。)
	Item	オーバーロードされます。 この ConfigurationElement オブジェクトのプロパティ、属性、または子要素を取得または設定します。(ConfigurationElement から継承されます。)
	Properties	プロパティのコレクションを取得します。(ConfigurationElement から継承されます。)

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 現在の ConfigurationElement インスタンスを、指定したオブジェクトと比較します。 (ConfigurationElement から継承されます。)
	GetHashCode	現在の ConfigurationElement インスタンスを表す一意の値を取得します。 (ConfigurationElement から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	IsReadOnly	ConfigurationElement オブジェクトが読み取り専用かどうかを示す値を取得します。 (ConfigurationElement から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	DeserializeElement	構成ファイルから XML を読み取ります。 (ConfigurationElement から継承されます。)
	DeserializeSection	構成ファイルから XML を読み取ります。 (ConfigurationSection から継承されます。)
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	GetRuntimeObject	派生クラスでオーバーライドされると、カスタム オブジェクトを返します。 (ConfigurationSection から継承されます。)
	Init	ConfigurationElement オブジェクトを初期状態に設定します。 (ConfigurationElement から継承されます。)
	InitializeDefault	ConfigurationElement オブジェクトの既定の値セットを初期化するために使用します。 (ConfigurationElement から継承されます。)
	IsModified	派生クラスに実装された場合、この構成要素が最後の保存または読み込み以降に変更されたかどうかを示します。 (ConfigurationSection から継承されます。)
	ListErrors	この ConfigurationElement オブジェクトおよびすべてのサブ要素の無効なプロパティのエラーを、渡されたリストに追加します。 (ConfigurationElement から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)
	OnDeserializeUnrecognizedAttribute	逆シリカル化中に不明な属性が発生したかどうかを示す値を取得します。 (ConfigurationElement から継承されます。)
	OnDeserializeUnrecognizedElement	逆シリカル化中に不明な要素が発生したかどうかを示す値を取得します。 (ConfigurationElement から継承されます。)
	OnRequiredPropertyNotFound	必須プロパティが見つからなかったかどうかを示す値を取得します。 (ConfigurationElement から継承されます。)
	PostDeserialize	逆シリアル化後に呼び出されます。 (ConfigurationElement から継承されます。)
	PreSerialize	シリアル化前に呼び出されます。 (ConfigurationElement から継承されます。)
	Reset	ConfigurationElement オブジェクトの内部状態 (ロックやプロパティ コレクションなど) をリセットします。 (ConfigurationElement から継承されます。)
	ResetModified	派生クラスに実装された場合、IsModified メソッドの値を false にリセットします。 (ConfigurationSection から継承されます。)
	SerializeElement	派生クラスに実装されている場合、この構成要素の内容を構成ファイルに書き込みます。 (ConfigurationElement から継承されます。)
	SerializeSection	ファイルに書き込む 1 つのセクションとして、ConfigurationSection オブジェクトのアンマージされたビューを含む XML 文字列を作成します。 (ConfigurationSection から継承されます。)
	SerializeToXmlElement	派生クラスに実装されている場合、この構成要素の外側のタグを構成ファイルに書き込みます。 (ConfigurationElement から継承されます。)
	SetPropertyValue	プロパティを指定した値に設定します。 (ConfigurationElement から継承されます。)
	SetReadOnly	ConfigurationElement オブジェクトおよびすべてのサブ要素に IsReadOnly プロパティを設定します。 (ConfigurationElement から継承されます。)
	Unmerge	保存しないすべての値を削除するには、ConfigurationElement オブジェクトを変更します。 (ConfigurationElement から継承されます。)

参照

関連項目

SiteMapSection クラス
System.Web.Configuration 名前空間
ConfigurationSection
SiteMapPath
SiteMap クラス

その他の技術情報

siteMap 要素 (ASP.NET 設定スキーマ)