SiteMapNode Klasse

Definition

public ref class SiteMapNode : ICloneable, System::Web::UI::IHierarchyData, System::Web::UI::INavigateUIData

public class SiteMapNode : ICloneable, System.Web.UI.IHierarchyData, System.Web.UI.INavigateUIData

type SiteMapNode = class
    interface ICloneable
    interface IHierarchyData
    interface INavigateUIData

Public Class SiteMapNode
Implements ICloneable, IHierarchyData, INavigateUIData

Vererbung

Object

SiteMapNode

Implementiert

ICloneable IHierarchyData INavigateUIData

Beispiele

Dieser Abschnitt enthält zwei Codebeispiele. Im ersten Codebeispiel wird veranschaulicht, wie Sie eine neue Websitezuordnungsknotensammlung erstellen und ihr Elemente hinzufügen. Im zweiten Codebeispiel wird veranschaulicht, wie Websitezuordnungsdaten aus einer Textdatei geladen werden.

Im folgenden Codebeispiel wird veranschaulicht, wie der SiteMapNodeCollection Konstruktor zum Erstellen einer neuen SiteMapNodeCollection Auflistung verwendet und anschließend elemente mit der Add Methode hinzugefügt wird.

// The LoadSiteMapData() method loads site navigation
// data from persistent storage into a DataTable.
DataTable siteMap = LoadSiteMapData();

// Create a SiteMapNodeCollection.
SiteMapNodeCollection nodes = new SiteMapNodeCollection();

// Create a SiteMapNode and add it to the collection.
SiteMapNode tempNode;
DataRow row;
int index = 0;

while (index < siteMap.Rows.Count)
{

    row = siteMap.Rows[index];

    // Create a node based on the data in the DataRow.
    tempNode = new SiteMapNode(SiteMap.Provider,
                                row["Key"].ToString(),
                                row["Url"].ToString());

    // Add the node to the collection.
    nodes.Add(tempNode);
    ++index;
}

' The LoadSiteMapData() Function loads site navigation
' data from persistent storage into a DataTable.

Dim siteMapData As DataTable
siteMapData = LoadSiteMapData()

' Create a SiteMapNodeCollection.
Dim nodes As New SiteMapNodeCollection()

' Create a SiteMapNode and add it to the collection.
Dim tempNode As SiteMapNode
Dim row As DataRow
Dim index As Integer
index = 0

While (index < siteMapData.Rows.Count)

    row = siteMapData.Rows(index)

    ' Create a node based on the data in the DataRow.
    tempNode = New SiteMapNode(SiteMap.Provider, row("Key").ToString(), row("Url").ToString())

    ' Add the node to the collection.
    nodes.Add(tempNode)
    index = index + 1
End While

Im folgenden Codebeispiel wird veranschaulicht, wie die SimpleTextSiteMapProvider Parsen einer Textdatei, die Websitezuordnungsdaten in durch Trennzeichen getrennten Zeichenfolgen enthält. Ein neues SiteMapNode Objekt wird den internen Nachverfolgungsauflistungen der Klasse für jede Zeile hinzugefügt, die aus der Datei gelesen wird.

Dieses Codebeispiel ist Teil eines größeren Beispiels, das für die SiteMapProvider Klasse bereitgestellt wird.

protected virtual void LoadSiteMapFromStore()
{
  string pathToOpen;

  lock (this)
  {
    // If a root node exists, LoadSiteMapFromStore has already
    // been called, and the method can return.
    if (rootNode != null)
    {
      return;
    }
    else
    {
      pathToOpen = HttpContext.Current.Server.MapPath("~" + "\\" + sourceFilename);

      if (File.Exists(pathToOpen))
      {
        // Open the file to read from.
        using (StreamReader sr = File.OpenText(pathToOpen))
        {

          // Clear the state of the collections and rootNode
          rootNode = null;
          siteMapNodes.Clear();
          childParentRelationship.Clear();

          // Parse the file and build the site map
          string s = "";
          string[] nodeValues = null;
          SiteMapNode temp = null;

          while ((s = sr.ReadLine()) != null)
          {

            // Build the various SiteMapNode objects and add
            // them to the ArrayList collections. The format used
            // is: URL,TITLE,DESCRIPTION,PARENTURL

            nodeValues = s.Split(',');

            temp = new SiteMapNode(this,
                HttpRuntime.AppDomainAppVirtualPath + "/" + nodeValues[0],
                HttpRuntime.AppDomainAppVirtualPath + "/" + nodeValues[0],
                nodeValues[1],
                nodeValues[2]);

            // Is this a root node yet?
            if (null == rootNode &&
                string.IsNullOrEmpty(nodeValues[3]))
            {
              rootNode = temp;
            }

          // If not the root node, add the node to the various collections.
            else
            {
              siteMapNodes.Add(new DictionaryEntry(temp.Url, temp));
              // The parent node has already been added to the collection.
              SiteMapNode parentNode =
                       FindSiteMapNode(HttpRuntime.AppDomainAppVirtualPath + "/" + nodeValues[3]);
              if (parentNode != null)
              {
                childParentRelationship.Add(new DictionaryEntry(temp.Url, parentNode));
              }
              else
              {
                throw new Exception("Parent node not found for current node.");
              }
            }
          }
        }
      }
      else
      {
        throw new Exception("File not found");
      }
    }
  }
  return;
}

  Protected Overridable Sub LoadSiteMapFromStore()
    Dim pathToOpen As String
    SyncLock Me
      ' If a root node exists, LoadSiteMapFromStore has already
      ' been called, and the method can return.
      If Not (aRootNode Is Nothing) Then
        Return
      Else
        pathToOpen = HttpContext.Current.Server.MapPath("~" & "\\" & sourceFilename)
        If File.Exists(pathToOpen) Then
          ' Open the file to read from.
          Dim sr As StreamReader = File.OpenText(pathToOpen)
          Try

            ' Clear the state of the collections and aRootNode
            aRootNode = Nothing
            siteMapNodes.Clear()
            childParentRelationship.Clear()

            ' Parse the file and build the site map
            Dim s As String = ""
            Dim nodeValues As String() = Nothing
            Dim temp As SiteMapNode = Nothing

            Do
              s = sr.ReadLine()

              If Not s Is Nothing Then
                ' Build the various SiteMapNode objects and add
                ' them to the ArrayList collections. The format used
                ' is: URL,TITLE,DESCRIPTION,PARENTURL
                nodeValues = s.Split(","c)

                temp = New SiteMapNode(Me, _
                    HttpRuntime.AppDomainAppVirtualPath & "/" & nodeValues(0), _
                    HttpRuntime.AppDomainAppVirtualPath & "/" & nodeValues(0), _
                    nodeValues(1), _
                    nodeValues(2))

                ' Is this a root node yet?
                If aRootNode Is Nothing AndAlso _
                  (nodeValues(3) Is Nothing OrElse _
                   nodeValues(3) = String.Empty) Then
                  aRootNode = temp

                  ' If not the root node, add the node to the various collections.
                Else

                  siteMapNodes.Add(New DictionaryEntry(temp.Url, temp))

                  ' The parent node has already been added to the collection.
                  Dim parentNode As SiteMapNode = _
                      FindSiteMapNode(HttpRuntime.AppDomainAppVirtualPath & "/" & nodeValues(3))

                  If Not (parentNode Is Nothing) Then
                    childParentRelationship.Add(New DictionaryEntry(temp.Url, parentNode))
                  Else
                    Throw New Exception("Parent node not found for current node.")
                  End If
                End If
              End If
            Loop Until s Is Nothing
          Finally
            sr.Close()
          End Try
        Else
          Throw New Exception("File not found")
        End If
      End If
    End SyncLock
    Return
  End Sub
End Class

Hinweise

Ein SiteMapNode Objekt stellt eine Websiteseite in einer Websitezuordnungsstruktur dar. SiteMapNode Objekte werden zur Laufzeit von der statischen SiteMap Klasse mit einem oder mehreren Websitezuordnungsanbietern geladen, um Websitezuordnungsdaten aus dem beständigen Speicher in den Arbeitsspeicher zu laden. SiteMapNode Objekte werden von der Klasse für die SiteMapNodeItem Verwendung durch Webserversteuerelemente wie das SiteMapPath Steuerelement umschlossen.

Die SiteMapNode Klasse enthält mehrere Eigenschaften, die zum Beschreiben einer einzelnen Seite auf einer Website verwendet werden, einschließlich Eigenschaften, die eine Seite beschreiben, z. B. die UrlEigenschaften , Titleund Description Eigenschaften. Während die Url Eigenschaft von der Klasse verwendet wird, bei der XmlSiteMapProvider es sich um den Standardmäßigen Websitezuordnungsanbieter für ASP.NET handelt, als Nachschlageschlüssel in den internen Auflistungen, die der Anbieter zum Nachverfolgen von Knoten verwendet, unterstützt die SiteMapNode Klasse eine grundlegende Key Eigenschaft, die von Websitekartenanbietern zum Nachverfolgen von Knoten verwendet werden kann. Darüber hinaus wird die Url Eigenschaft von Navigationssteuerelementen verwendet, um Links zu Seiten innerhalb einer Navigationsstruktur zu rendern. Die Title Eigenschaft ist ein Anzeigename für den SiteMapNode, ist häufig identisch mit dem HTML-Titel eines Webformulars und wird von Navigationssteuerelementen verwendet, um einfache Beschriftungen zu rendern. Schließlich steht eine NameValueCollection Sammlung zusätzlicher Attributes Attribute für Websitezuordnungsanbieter zur Verfügung, die Objekte verwenden SiteMapNode , erfordern jedoch zusätzliche Eigenschaften, die in der Basisklasse SiteMapNode nicht verfügbar sind.

Weitere Informationen

• SiteMap
• SiteMapProvider
• XmlSiteMapProvider
• übersicht über die websitenavigation ASP.NET
• ASP.NET Websitekarten