SiteMapSection Класс

Ссылка

Определение

Пространство имен:: System.Web.Configuration

Сборка:: System.Web.dll

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

Определяет настройки конфигурации, используемые для поддержки инфраструктуры для конфигурирования, хранения и отрисовки навигации узла. Этот класс не наследуется.

public ref class SiteMapSection sealed : System::Configuration::ConfigurationSection

public sealed class SiteMapSection : System.Configuration.ConfigurationSection

type SiteMapSection = class
    inherit ConfigurationSection

Public NotInheritable Class SiteMapSection
Inherits ConfigurationSection

Наследование: Object

ConfigurationElement

ConfigurationSection
SiteMapSection

Примеры

В этом примере показано, как декларативно указывать значения для нескольких атрибутов 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()

Инициализирует новый экземпляр класса SiteMapSection с использованием параметров по умолчанию.

Свойства

CurrentConfiguration	Возвращает ссылку на экземпляр Configuration верхнего уровня, представляющий иерархию конфигурации, к которой относится текущий экземпляр ConfigurationElement. (Унаследовано от ConfigurationElement)
DefaultProvider	Получает или задает имя поставщика навигации по умолчанию.
ElementInformation	Возвращает объект ElementInformation, содержащий неизменяемую информацию и функциональность объекта ConfigurationElement. (Унаследовано от ConfigurationElement)
ElementProperty	Возвращает объект ConfigurationElementProperty, представляющий сам объект ConfigurationElement. (Унаследовано от ConfigurationElement)
Enabled	Получает или задает значение, указывающее, включена ли функция карты веб-узла ASP.NET.
EvaluationContext	Возвращает объект ContextInformation для объекта ConfigurationElement. (Унаследовано от ConfigurationElement)
HasContext	Возвращает значение, указывающее, имеет ли свойство CurrentConfiguration значение `null`. (Унаследовано от ConfigurationElement)
Item[ConfigurationProperty]	Возвращает или задает свойство или атрибут данного элемента конфигурации. (Унаследовано от ConfigurationElement)
Item[String]	Получает или задает свойство, атрибут или дочерний элемент данного элемента конфигурации. (Унаследовано от ConfigurationElement)
LockAllAttributesExcept	Возвращает коллекцию заблокированных атрибутов. (Унаследовано от ConfigurationElement)
LockAllElementsExcept	Возвращает коллекцию заблокированных элементов. (Унаследовано от ConfigurationElement)
LockAttributes	Возвращает коллекцию заблокированных атрибутов. (Унаследовано от ConfigurationElement)
LockElements	Возвращает коллекцию заблокированных элементов. (Унаследовано от ConfigurationElement)
LockItem	Возвращает или задает значение, указывающее, заблокирован ли элемент. (Унаследовано от ConfigurationElement)
Properties	Возвращает коллекцию свойств. (Унаследовано от ConfigurationElement)
Providers	Получает коллекцию ProviderSettingsCollection объектов ProviderSettings.
SectionInformation	Возвращает объект SectionInformation, содержащий неизменяемую информацию и функциональность объекта ConfigurationSection. (Унаследовано от ConfigurationSection)

Методы

DeserializeElement(XmlReader, Boolean)	Считывает XML из файла конфигурации. (Унаследовано от ConfigurationElement)
DeserializeSection(XmlReader)	Считывает XML из файла конфигурации. (Унаследовано от ConfigurationSection)
Equals(Object)	Сравнивает текущий экземпляр ConfigurationElement с указанным объектом. (Унаследовано от ConfigurationElement)
GetHashCode()	Получает уникальное значение, представляющее текущий экземпляр ConfigurationElement. (Унаследовано от ConfigurationElement)
GetRuntimeObject()	Возвращает пользовательский объект при переопределении в производном классе. (Унаследовано от ConfigurationSection)
GetTransformedAssemblyString(String)	Возвращает преобразованную версию указанного имени сборки. (Унаследовано от ConfigurationElement)
GetTransformedTypeString(String)	Возвращает преобразованную версию указанного имени типа. (Унаследовано от ConfigurationElement)
GetType()	Возвращает объект Type для текущего экземпляра. (Унаследовано от Object)
Init()	Задает объект ConfigurationElement в исходное состояние. (Унаследовано от ConfigurationElement)
InitializeDefault()	Используется для инициализации набора значений по умолчанию для объекта ConfigurationElement. (Унаследовано от ConfigurationElement)
IsModified()	При реализации в производном классе указывает, был ли изменен данный элемент конфигурации с момента последнего сохранения или загрузки. (Унаследовано от ConfigurationSection)
IsReadOnly()	Получает значение, показывающее, является ли объект ConfigurationElement доступным только для чтения. (Унаследовано от ConfigurationElement)
ListErrors(IList)	Добавляет ошибку "недействительное свойство" в данном объекте ConfigurationElement и всех его дочерних элементах к переданному списку. (Унаследовано от ConfigurationElement)
MemberwiseClone()	Создает неполную копию текущего объекта Object. (Унаследовано от Object)
OnDeserializeUnrecognizedAttribute(String, String)	Возвращает значение, указывающее, встретился ли неизвестный атрибут при десериализации. (Унаследовано от ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)	Возвращает значение, указывающее, встретился ли неизвестный элемент при десериализации. (Унаследовано от ConfigurationElement)
OnRequiredPropertyNotFound(String)	Выдает исключение, если требуемое свойство не найдено. (Унаследовано от ConfigurationElement)
PostDeserialize()	Вызывается после десериализации. (Унаследовано от ConfigurationElement)
PreSerialize(XmlWriter)	Вызывается до сериализации. (Унаследовано от ConfigurationElement)
Reset(ConfigurationElement)	Восстанавливает внутреннее состояние объекта ConfigurationElement, включая блокировки и коллекции свойств. (Унаследовано от ConfigurationElement)
ResetModified()	Переустанавливает значение метода IsModified() в `false` при реализации в производном классе. (Унаследовано от ConfigurationSection)
SerializeElement(XmlWriter, Boolean)	Записывает содержание данного элемента конфигурации в файл конфигурации при реализации в производном классе. (Унаследовано от ConfigurationElement)
SerializeSection(ConfigurationElement, String, ConfigurationSaveMode)	Создает XML-строку, содержащую разъединенное представление об объекте ConfigurationSection, как об отдельном разделе, записываемым в файл. (Унаследовано от ConfigurationSection)
SerializeToXmlElement(XmlWriter, String)	Записывает внешние теги данного элемента конфигурации в файл конфигурации при реализации в производном классе. (Унаследовано от ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)	Задает для свойства указанное значение. (Унаследовано от ConfigurationElement)
SetReadOnly()	Задает свойство IsReadOnly() для объекта ConfigurationElement и всех подчиненных элементов. (Унаследовано от ConfigurationElement)
ShouldSerializeElementInTargetVersion(ConfigurationElement, String, FrameworkName)	Указывает, следует ли сериализовать указанный элемент при сериализации иерархии объектов конфигурации для указанной целевой версии платформа .NET Framework. (Унаследовано от ConfigurationSection)
ShouldSerializePropertyInTargetVersion(ConfigurationProperty, String, FrameworkName, ConfigurationElement)	Указывает, следует ли сериализовать указанное свойство при сериализации иерархии объектов конфигурации для указанной целевой версии платформа .NET Framework. (Унаследовано от ConfigurationSection)
ShouldSerializeSectionInTargetVersion(FrameworkName)	Указывает, следует ли сериализовать текущий ConfigurationSection экземпляр при сериализации иерархии объектов конфигурации для указанной целевой версии платформа .NET Framework. (Унаследовано от ConfigurationSection)
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)	Изменяет объект ConfigurationElement для удаления всех значений, которые не должны сохраняться. (Унаследовано от ConfigurationElement)

Применяется к

Поделиться через