SiteMapProvider Klasa

Definicja

Udostępnia wspólną klasę bazową dla wszystkich dostawców danych mapy lokacji oraz umożliwia deweloperom implementowanie niestandardowych dostawców danych mapy lokacji, których można używać z infrastrukturą mapy lokacji ASP.NET jako magazynami trwałymi dla SiteMap obiektów.

C#
public abstract class SiteMapProvider : System.Configuration.Provider.ProviderBase
Dziedziczenie
SiteMapProvider
Pochodne

Przykłady

W poniższym przykładzie kodu pokazano, jak napisać klasę, która implementuje klasę abstrakcyjną SiteMapProvider . Ten przykład zawiera tylko przykładowy SiteMapProvider i przykładowy plik tekstowy, który z nim współpracuje. Aby uruchomić przykład, potrzebny jest również wpis w pliku Web.config i na stronie .aspx. Można je znaleźć w dokumentacji właściwości SiteMapDataSource.SiteMapProvider .

W przykładzie użyto pliku rozdzielanego przecinkami, który jest zgodny z oczekiwaną strukturą w celu załadowania informacji o mapie witryny. Pierwszy wiersz pliku reprezentuje węzeł główny mapy witryny, a kolejne wiersze są podwęźami. Każdy podwęźle identyfikuje węzeł nadrzędny według adresu URL. Poniżej przedstawiono przykład pliku spełniającego te kryteria.

default.aspx,Home,MyCompany Home Page,  
sale.aspx,Now On Sale,Check Out These Great Deals!,default.aspx  
catalog.aspx,Online Catalog,Browse Our Many Great Items!,default.aspx  

Zawiera SimpleTextSiteMapProvider przykładowe implementacje wszystkich SiteMapProvider właściwości i metod.

C#
using System;
using System.Configuration.Provider;
using System.Collections;
using System.Collections.Specialized;
using System.IO;
using System.Security.Permissions;
using System.Web;

namespace Samples.AspNet.CS
{

  [AspNetHostingPermission(SecurityAction.Demand, Level = AspNetHostingPermissionLevel.Minimal)]
  public class SimpleTextSiteMapProvider : SiteMapProvider
  {
    private SiteMapProvider parentSiteMapProvider = null;
    private string simpleTextProviderName = null;
    private string sourceFilename = null;
    private SiteMapNode rootNode = null;
    private ArrayList siteMapNodes = null;
    private ArrayList childParentRelationship = null;

    // A default constructor. The Name property is initialized in the
    // Initialize method.
    public SimpleTextSiteMapProvider()
    {
    }
    // Implement the CurrentNode property.
    public override SiteMapNode CurrentNode
    {
      get
      {
        string currentUrl = FindCurrentUrl();
        // Find the SiteMapNode that represents the current page.
        SiteMapNode currentNode = FindSiteMapNode(currentUrl);
        return currentNode;
      }
    }

    // Implement the RootNode property.
    public override SiteMapNode RootNode
    {
      get
      {
        return rootNode;
      }
    }
    // Implement the ParentProvider property.
    public override SiteMapProvider ParentProvider
    {
      get
      {
        return parentSiteMapProvider;
      }
      set
      {
        parentSiteMapProvider = value;
      }
    }

    // Implement the RootProvider property.
    public override SiteMapProvider RootProvider
    {
      get
      {
        // If the current instance belongs to a provider hierarchy, it
        // cannot be the RootProvider. Rely on the ParentProvider.
        if (this.ParentProvider != null)
        {
          return ParentProvider.RootProvider;
        }
        // If the current instance does not have a ParentProvider, it is
        // not a child in a hierarchy, and can be the RootProvider.
        else
        {
          return this;
        }
      }
    }
    // Implement the FindSiteMapNode method.
    public override SiteMapNode FindSiteMapNode(string rawUrl)
    {

      // Does the root node match the URL?
      if (RootNode.Url == rawUrl)
      {
        return RootNode;
      }
      else
      {
        SiteMapNode candidate = null;
        // Retrieve the SiteMapNode that matches the URL.
        lock (this)
        {
          candidate = GetNode(siteMapNodes, rawUrl);
        }
        return candidate;
      }
    }
    // Implement the GetChildNodes method.
    public override SiteMapNodeCollection GetChildNodes(SiteMapNode node)
    {
      SiteMapNodeCollection children = new SiteMapNodeCollection();
      // Iterate through the ArrayList and find all nodes that have the specified node as a parent.
      lock (this)
      {
        for (int i = 0; i < childParentRelationship.Count; i++)
        {

          string nodeUrl = ((DictionaryEntry)childParentRelationship[i]).Key as string;

          SiteMapNode parent = GetNode(childParentRelationship, nodeUrl);

          if (parent != null && node.Url == parent.Url)
          {
            // The SiteMapNode with the Url that corresponds to nodeUrl
            // is a child of the specified node. Get the SiteMapNode for
            // the nodeUrl.
            SiteMapNode child = FindSiteMapNode(nodeUrl);
            if (child != null)
            {
              children.Add(child as SiteMapNode);
            }
            else
            {
              throw new Exception("ArrayLists not in sync.");
            }
          }
        }
      }
      return children;
    }
    protected override SiteMapNode GetRootNodeCore()
    {
      return RootNode;
    }
    // Implement the GetParentNode method.
    public override SiteMapNode GetParentNode(SiteMapNode node)
    {
      // Check the childParentRelationship table and find the parent of the current node.
      // If there is no parent, the current node is the RootNode.
      SiteMapNode parent = null;
      lock (this)
      {
        // Get the Value of the node in childParentRelationship
        parent = GetNode(childParentRelationship, node.Url);
      }
      return parent;
    }

    // Implement the ProviderBase.Initialize property.
    // Initialize is used to initialize the state that the Provider holds, but
    // not actually build the site map.
    public override void Initialize(string name, NameValueCollection attributes)
    {

      lock (this)
      {

        base.Initialize(name, attributes);

        simpleTextProviderName = name;
        sourceFilename = attributes["siteMapFile"];
        siteMapNodes = new ArrayList();
        childParentRelationship = new ArrayList();

        // Build the site map in memory.
        LoadSiteMapFromStore();
      }
    }
    // Private helper methods

    private SiteMapNode GetNode(ArrayList list, string url)
    {
      for (int i = 0; i < list.Count; i++)
      {
        DictionaryEntry item = (DictionaryEntry)list[i];
        if ((string)item.Key == url)
          return item.Value as SiteMapNode;
      }
      return null;
    }

    // Get the URL of the currently displayed page.
    private string FindCurrentUrl()
    {
      try
      {
        // The current HttpContext.
        HttpContext currentContext = HttpContext.Current;
        if (currentContext != null)
        {
          return currentContext.Request.RawUrl;
        }
        else
        {
          throw new Exception("HttpContext.Current is Invalid");
        }
      }
      catch (Exception e)
      {
        throw new NotSupportedException("This provider requires a valid context.",e);
      }
    }
    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;
    }
  }
}

Uwagi

Klasy StaticSiteMapProvider i XmlSiteMapProvider reprezentują domyślne implementacje klasy abstrakcyjnej SiteMapProvider . Do XmlSiteMapProvider przechowywania danych mapy witryny jest używany plik XML o nazwie Web.sitemap. Aby uzyskać więcej informacji na temat pliku web.sitemap, zobacz ASP.NET Mapy witryn.

Klasa SiteMapProvider obsługuje koncepcję hierarchii dostawcy mapy lokacji, deklarując RootProvider właściwości i ParentProvider . Element SiteMapProvider może być elementem podrzędnym lub nadrzędnym innego dostawcy. Umożliwia to scenariusze, w których różne obszary zawartości witryny są własnością lub implementowane przez różne grupy deweloperów, które utrzymują własne mapy witryny i dostawców map witryn.

Wszystkie SiteMapProvider obiekty są konfigurowane w plikach Web.config. Każdy dostawca mapy lokacji zadeklarowany w tych plikach konfiguracji jest ładowany w czasie wykonywania i służy do ładowania i przetwarzania danych nawigacji lokacji. Obiekt SiteMap , który śledzi wszystkich dostawców, którzy są do niego dostęp za pośrednictwem kolekcji Providers właściwości, zapewnia programowy dostęp do danych nawigacji zarządzanych przez dostawców. Poniższy przykład kodu przedstawia format używany do deklarowania dostawcy mapy lokacji w pliku Web.config.

<siteMap defaultProvider="<name>">  
  <providers>  
    <add  
      name="<friendly name>"  
      type="<fully qualified class name>, <assembly name (optional)>"   
      siteMapFile = "<file name>" />  
  </providers>  
</siteMap>  

Dane nawigacji lokacji ładowane przez tych dostawców są używane przez inne składniki infrastruktury mapy lokacji, takie jak SiteMapPath kontrolki i TreeView , do wyświetlania informacji o mapie witryny dla użytkowników.

Jeśli zaimplementujesz własnego dostawcę mapy witryny, możesz umieścić plik źródłowy w katalogu App_Code aplikacji ASP.NET, a następnie zestaw zostanie skompilowany automatycznie. Możesz również umieścić własnego dostawcę mapy witryny w globalnej pamięci podręcznej zestawów (GAC) i podać do niego w pełni kwalifikowane odwołanie w pliku Web.config. Aby uzyskać więcej informacji na temat usług kompilatora, zobacz Praca z zestawami i globalną pamięcią podręczną zestawów.

Uwagi dotyczące implementowania

Podczas dziedziczenia SiteMapProvider z klasy należy zastąpić następujące elementy członkowskie: GetRootNodeCore(), FindSiteMapNode(String), GetChildNodes(SiteMapNode)i GetParentNode(SiteMapNode).

Konstruktory

SiteMapProvider()

Inicjuje nowe wystąpienie klasy SiteMapProvider.

Właściwości

CurrentNode

SiteMapNode Pobiera obiekt reprezentujący aktualnie żądaną stronę.

Description

Pobiera krótki, przyjazny opis odpowiedni do wyświetlania w narzędziach administracyjnych lub innych interfejsach użytkownika (UI).

(Odziedziczone po ProviderBase)
EnableLocalization

Pobiera lub ustawia wartość logiczną wskazującą, czy zwracane są zlokalizowane wartości atrybutów SiteMapNode .

Name

Pobiera przyjazną nazwę używaną do odwoływania się do dostawcy podczas konfiguracji.

(Odziedziczone po ProviderBase)
ParentProvider

Pobiera lub ustawia obiekt nadrzędny SiteMapProvider bieżącego dostawcy.

ResourceKey

Pobierz lub ustawia klucz zasobu używany do lokalizowania SiteMapNode atrybutów.

RootNode

Pobiera obiekt główny SiteMapNode danych mapy witryny reprezentowanych przez bieżącego dostawcę.

RootProvider

Pobiera obiekt główny SiteMapProvider w bieżącej hierarchii dostawcy.

SecurityTrimmingEnabled

Pobiera wartość logiczną wskazującą, czy dostawca mapy lokacji filtruje węzły mapy witryny na podstawie roli użytkownika.

Metody

AddNode(SiteMapNode)

SiteMapNode Dodaje obiekt do kolekcji węzłów obsługiwanej przez dostawcę mapy witryny.

AddNode(SiteMapNode, SiteMapNode)

SiteMapNode Dodaje obiekt do kolekcji węzłów, która jest utrzymywana przez dostawcę mapy witryny i określa obiekt nadrzędnySiteMapNode.

Equals(Object)

Określa, czy dany obiekt jest taki sam, jak bieżący obiekt.

(Odziedziczone po Object)
FindSiteMapNode(HttpContext)

SiteMapNode Pobiera obiekt reprezentujący aktualnie żądaną stronę przy użyciu określonego HttpContext obiektu.

FindSiteMapNode(String)

Po przesłonięciu SiteMapNode w klasie pochodnej pobiera obiekt reprezentujący stronę pod określonym adresem URL.

FindSiteMapNodeFromKey(String)

SiteMapNode Pobiera obiekt na podstawie określonego klucza.

GetChildNodes(SiteMapNode)

Po przesłonięciu w klasie pochodnej pobiera węzły podrzędne określonego SiteMapNodeelementu .

GetCurrentNodeAndHintAncestorNodes(Int32)

Udostępnia zoptymalizowaną metodę wyszukiwania dla dostawców mapy witryny podczas pobierania węzła dla aktualnie żądanej strony i pobierania węzłów mapy witryny nadrzędnej i nadrzędnej dla bieżącej strony.

GetCurrentNodeAndHintNeighborhoodNodes(Int32, Int32)

Udostępnia zoptymalizowaną metodę wyszukiwania dla dostawców mapy lokacji podczas pobierania węzła dla aktualnie żądanej strony i pobierania węzłów mapy witryny w pobliżu bieżącego węzła.

GetHashCode()

Służy jako domyślna funkcja skrótu.

(Odziedziczone po Object)
GetParentNode(SiteMapNode)

Podczas zastępowania w klasie pochodnej pobiera węzeł nadrzędny określonego SiteMapNode obiektu.

GetParentNodeRelativeToCurrentNodeAndHintDownFromParent(Int32, Int32)

Udostępnia zoptymalizowaną metodę wyszukiwania dla dostawców mapy lokacji podczas pobierania węzła przodka dla aktualnie żądanej strony i pobierania węzłów podrzędnych dla obiektu nadrzędnym.

GetParentNodeRelativeToNodeAndHintDownFromParent(SiteMapNode, Int32, Int32)

Udostępnia zoptymalizowaną metodę wyszukiwania dla dostawców mapy lokacji podczas pobierania węzła nadrzędnego dla określonego SiteMapNode obiektu i pobierania jego węzłów podrzędnych.

GetRootNodeCore()

Po zastąpieniu w klasie pochodnej pobiera węzeł główny wszystkich węzłów, które są obecnie zarządzane przez bieżącego dostawcę.

GetRootNodeCoreFromProvider(SiteMapProvider)

Pobiera węzeł główny wszystkich węzłów, które są obecnie zarządzane przez określonego dostawcę mapy lokacji.

GetType()

Type Pobiera wartość bieżącego wystąpienia.

(Odziedziczone po Object)
HintAncestorNodes(SiteMapNode, Int32)

Udostępnia metodę, którą dostawcy mapy lokacji mogą zastąpić w celu przeprowadzenia zoptymalizowanego pobierania jednego lub większej liczby poziomów węzłów nadrzędnych i węzłów nadrzędnych względem określonego SiteMapNode obiektu.

HintNeighborhoodNodes(SiteMapNode, Int32, Int32)

Udostępnia metodę, którą dostawcy mapy lokacji mogą zastąpić w celu przeprowadzenia zoptymalizowanego pobierania węzłów znajdujących się w pobliżu określonego węzła.

Initialize(String, NameValueCollection)

Inicjuje implementację SiteMapProvider , w tym wszystkie zasoby potrzebne do załadowania danych mapy lokacji z magazynu trwałego.

IsAccessibleToUser(HttpContext, SiteMapNode)

Pobiera wartość logiczną wskazującą, czy określony SiteMapNode obiekt może być wyświetlany przez użytkownika w określonym kontekście.

MemberwiseClone()

Tworzy płytkią kopię bieżącego Objectelementu .

(Odziedziczone po Object)
RemoveNode(SiteMapNode)

Usuwa określony SiteMapNode obiekt z kolekcji węzłów obsługiwanej przez dostawcę mapy witryny.

ResolveSiteMapNode(HttpContext)

SiteMapResolve Zgłasza zdarzenie.

ToString()

Zwraca ciąg reprezentujący bieżący obiekt.

(Odziedziczone po Object)

Zdarzenia

SiteMapResolve

Występuje, gdy właściwość jest wywoływana CurrentNode .

Dotyczy

Produkt Wersje
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

Zobacz też