SiteMapSection Klasa
Definicja
Ważne
Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.
Definiuje ustawienia konfiguracji używane do obsługi infrastruktury do konfigurowania, przechowywania i renderowania nawigacji witryny. Klasa ta nie może być dziedziczona.
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
- Dziedziczenie
Przykłady
W tym przykładzie pokazano, jak deklaratywnie określić wartości dla kilku atrybutów siteMap
sekcji, do których można również uzyskać dostęp jako składowe SiteMapSection klasy.
Poniższy przykładowy plik konfiguracji przedstawia sposób deklaratywnego określania siteMap
wartości dla sekcji.
<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>
W poniższym przykładzie kodu pokazano, jak używać SiteMapSection klasy .
#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
Uwagi
Klasa SiteMapSection umożliwia programowy dostęp i modyfikowanie zawartości sekcji pliku siteMap
konfiguracji.
Konstruktory
SiteMapSection() |
Inicjuje SiteMapSection nowe wystąpienie klasy przy użyciu ustawień domyślnych. |
Właściwości
CurrentConfiguration |
Pobiera odwołanie do wystąpienia najwyższego poziomu Configuration , które reprezentuje hierarchię konfiguracji, do którego należy bieżące ConfigurationElement wystąpienie. (Odziedziczone po ConfigurationElement) |
DefaultProvider |
Pobiera lub ustawia nazwę domyślnego dostawcy nawigacji. |
ElementInformation |
ElementInformation Pobiera obiekt, który zawiera niezstosowalne informacje i funkcje ConfigurationElement obiektu. (Odziedziczone po ConfigurationElement) |
ElementProperty |
ConfigurationElementProperty Pobiera obiekt reprezentujący ConfigurationElement sam obiekt. (Odziedziczone po ConfigurationElement) |
Enabled |
Pobiera lub ustawia wartość wskazującą, czy funkcja mapy witryny ASP.NET jest włączona. |
EvaluationContext |
ContextInformation Pobiera obiekt dla ConfigurationElement obiektu. (Odziedziczone po ConfigurationElement) |
HasContext |
Pobiera wartość wskazującą, czy CurrentConfiguration właściwość to |
Item[ConfigurationProperty] |
Pobiera lub ustawia właściwość lub atrybut tego elementu konfiguracji. (Odziedziczone po ConfigurationElement) |
Item[String] |
Pobiera lub ustawia właściwość, atrybut lub element podrzędny tego elementu konfiguracji. (Odziedziczone po ConfigurationElement) |
LockAllAttributesExcept |
Pobiera kolekcję zablokowanych atrybutów. (Odziedziczone po ConfigurationElement) |
LockAllElementsExcept |
Pobiera kolekcję zablokowanych elementów. (Odziedziczone po ConfigurationElement) |
LockAttributes |
Pobiera kolekcję zablokowanych atrybutów. (Odziedziczone po ConfigurationElement) |
LockElements |
Pobiera kolekcję zablokowanych elementów. (Odziedziczone po ConfigurationElement) |
LockItem |
Pobiera lub ustawia wartość wskazującą, czy element jest zablokowany. (Odziedziczone po ConfigurationElement) |
Properties |
Pobiera kolekcję właściwości. (Odziedziczone po ConfigurationElement) |
Providers |
ProviderSettingsCollection Pobiera kolekcję ProviderSettings obiektów. |
SectionInformation |
SectionInformation Pobiera obiekt, który zawiera informacje i funkcje ConfigurationSection obiektu, które nie można dostosowywać. (Odziedziczone po ConfigurationSection) |
Metody
DeserializeElement(XmlReader, Boolean) |
Odczytuje kod XML z pliku konfiguracji. (Odziedziczone po ConfigurationElement) |
DeserializeSection(XmlReader) |
Odczytuje kod XML z pliku konfiguracji. (Odziedziczone po ConfigurationSection) |
Equals(Object) |
Porównuje bieżące ConfigurationElement wystąpienie z określonym obiektem. (Odziedziczone po ConfigurationElement) |
GetHashCode() |
Pobiera unikatową wartość reprezentującą bieżące ConfigurationElement wystąpienie. (Odziedziczone po ConfigurationElement) |
GetRuntimeObject() |
Zwraca obiekt niestandardowy, gdy zostanie zastąpiony w klasie pochodnej. (Odziedziczone po ConfigurationSection) |
GetTransformedAssemblyString(String) |
Zwraca przekształconą wersję określonej nazwy zestawu. (Odziedziczone po ConfigurationElement) |
GetTransformedTypeString(String) |
Zwraca przekształconą wersję określonej nazwy typu. (Odziedziczone po ConfigurationElement) |
GetType() |
Type Pobiera wartość bieżącego wystąpienia. (Odziedziczone po Object) |
Init() |
ConfigurationElement Ustawia obiekt na stan początkowy. (Odziedziczone po ConfigurationElement) |
InitializeDefault() |
Służy do inicjowania domyślnego zestawu wartości dla ConfigurationElement obiektu. (Odziedziczone po ConfigurationElement) |
IsModified() |
Wskazuje, czy ten element konfiguracji został zmodyfikowany od czasu ostatniego zapisania lub załadowania podczas implementacji w klasie pochodnej. (Odziedziczone po ConfigurationSection) |
IsReadOnly() |
Pobiera wartość wskazującą, czy ConfigurationElement obiekt jest tylko do odczytu. (Odziedziczone po ConfigurationElement) |
ListErrors(IList) |
Dodaje błędy nieprawidłowej właściwości w tym ConfigurationElement obiekcie i we wszystkich podelementach do przekazanej listy. (Odziedziczone po ConfigurationElement) |
MemberwiseClone() |
Tworzy płytkią kopię bieżącego Objectelementu . (Odziedziczone po Object) |
OnDeserializeUnrecognizedAttribute(String, String) |
Pobiera wartość wskazującą, czy podczas deserializacji napotkano nieznany atrybut. (Odziedziczone po ConfigurationElement) |
OnDeserializeUnrecognizedElement(String, XmlReader) |
Pobiera wartość wskazującą, czy podczas deserializacji napotkano nieznany element. (Odziedziczone po ConfigurationElement) |
OnRequiredPropertyNotFound(String) |
Zgłasza wyjątek, gdy nie znaleziono wymaganej właściwości. (Odziedziczone po ConfigurationElement) |
PostDeserialize() |
Wywoływana po deserializacji. (Odziedziczone po ConfigurationElement) |
PreSerialize(XmlWriter) |
Wywoływane przed serializacji. (Odziedziczone po ConfigurationElement) |
Reset(ConfigurationElement) |
Resetuje stan ConfigurationElement wewnętrzny obiektu, w tym blokady i kolekcje właściwości. (Odziedziczone po ConfigurationElement) |
ResetModified() |
Resetuje wartość IsModified() metody w |
SerializeElement(XmlWriter, Boolean) |
Zapisuje zawartość tego elementu konfiguracji do pliku konfiguracji po zaimplementowaniu w klasie pochodnej. (Odziedziczone po ConfigurationElement) |
SerializeSection(ConfigurationElement, String, ConfigurationSaveMode) |
Tworzy ciąg XML zawierający nieskonwergentny widok ConfigurationSection obiektu jako pojedynczą sekcję do zapisu w pliku. (Odziedziczone po ConfigurationSection) |
SerializeToXmlElement(XmlWriter, String) |
Zapisuje zewnętrzne tagi tego elementu konfiguracji do pliku konfiguracji po zaimplementowaniu w klasie pochodnej. (Odziedziczone po ConfigurationElement) |
SetPropertyValue(ConfigurationProperty, Object, Boolean) |
Ustawia właściwość na określoną wartość. (Odziedziczone po ConfigurationElement) |
SetReadOnly() |
IsReadOnly() Ustawia właściwość obiektu ConfigurationElement i wszystkich podelementów. (Odziedziczone po ConfigurationElement) |
ShouldSerializeElementInTargetVersion(ConfigurationElement, String, FrameworkName) |
Wskazuje, czy określony element powinien być serializowany, gdy hierarchia obiektów konfiguracji jest serializowana dla określonej wersji docelowej .NET Framework. (Odziedziczone po ConfigurationSection) |
ShouldSerializePropertyInTargetVersion(ConfigurationProperty, String, FrameworkName, ConfigurationElement) |
Wskazuje, czy określona właściwość powinna być serializowana, gdy hierarchia obiektów konfiguracji jest serializowana dla określonej wersji docelowej .NET Framework. (Odziedziczone po ConfigurationSection) |
ShouldSerializeSectionInTargetVersion(FrameworkName) |
Wskazuje, czy bieżące ConfigurationSection wystąpienie powinno być serializowane, gdy hierarchia obiektów konfiguracji jest serializowana dla określonej wersji docelowej .NET Framework. (Odziedziczone po ConfigurationSection) |
ToString() |
Zwraca ciąg reprezentujący bieżący obiekt. (Odziedziczone po Object) |
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode) |
Modyfikuje obiekt, ConfigurationElement aby usunąć wszystkie wartości, które nie powinny być zapisywane. (Odziedziczone po ConfigurationElement) |