SiteMapSection クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
サイト ナビゲーションを構成、格納、およびレンダリングするためのインフラストラクチャをサポートするために使用される構成設定を定義します。 このクラスは継承できません。
public ref class SiteMapSection sealed : System::Configuration::ConfigurationSectionpublic sealed class SiteMapSection : System.Configuration.ConfigurationSectiontype SiteMapSection = class
inherit ConfigurationSectionPublic NotInheritable Class SiteMapSection
Inherits ConfigurationSection- 継承
例
この例では、 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"/>
</providers>
</siteMap>
</system.web>
次のコード例は、 SiteMapSection クラスの使用方法を示しています。
#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();
}
}
}
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
注釈
SiteMapSection クラスは、構成ファイル siteMap セクションの内容にプログラムでアクセスして変更する方法を提供します。
コンストラクター
| 名前 | 説明 |
|---|---|
| SiteMapSection() |
既定の設定を使用して、 SiteMapSection クラスの新しいインスタンスを初期化します。 |