SiteMapProvider Kelas
Definisi
Penting
Beberapa informasi terkait produk prarilis yang dapat diubah secara signifikan sebelum dirilis. Microsoft tidak memberikan jaminan, tersirat maupun tersurat, sehubungan dengan informasi yang diberikan di sini.
Menyediakan kelas dasar umum untuk semua penyedia data peta situs, dan cara bagi pengembang untuk menerapkan penyedia data peta situs kustom yang dapat digunakan dengan infrastruktur peta situs ASP.NET sebagai penyimpanan persisten untuk SiteMap objek.
public ref class SiteMapProvider abstract : System::Configuration::Provider::ProviderBasepublic abstract class SiteMapProvider : System.Configuration.Provider.ProviderBasetype SiteMapProvider = class
inherit ProviderBasePublic MustInherit Class SiteMapProvider
Inherits ProviderBase- Warisan
- Turunan
Contoh
Contoh kode berikut menunjukkan cara menulis kelas yang mengimplementasikan kelas abstrak SiteMapProvider . Contoh ini hanya menyertakan sampel SiteMapProvider dan file teks sampel yang berfungsi dengannya. Untuk menjalankan contoh, Anda juga memerlukan entri di file Web.config dan halaman .aspx. Anda dapat menemukannya di dokumentasi untuk SiteMapDataSource.SiteMapProvider properti .
Contohnya menggunakan file yang dibatasi koma yang mengikuti struktur yang diharapkan untuk memuat informasi peta situs. Baris pertama file mewakili simpul akar peta situs, dan baris berikutnya adalah subnode. Setiap subnode mengidentifikasi simpul induknya berdasarkan URL. Contoh file yang memenuhi kriteria ini ditunjukkan di bawah ini.
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
SimpleTextSiteMapProvider memberikan contoh implementasi dari semua SiteMapProvider properti dan metode.
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;
}
}
}
Imports System.Collections
Imports System.Collections.Specialized
Imports System.Configuration.Provider
Imports System.IO
Imports System.Security.Permissions
Imports System.Web
Namespace Samples.AspNet.VB
<AspNetHostingPermission(SecurityAction.Demand, Level:=AspNetHostingPermissionLevel.Minimal)> _
Public Class SimpleTextSiteMapProvider
Inherits SiteMapProvider
Private parentSiteMapProvider As SiteMapProvider = Nothing
Private simpleTextProviderName As String = Nothing
Private sourceFilename As String = Nothing
Private aRootNode As SiteMapNode = Nothing
Private siteMapNodes As ArrayList = Nothing
Private childParentRelationship As ArrayList = Nothing
' A default constructor. The Name property is initialized in the
' Initialize method.
Public Sub New()
End Sub
' Implement the CurrentNode property.
Public Overrides ReadOnly Property CurrentNode() As SiteMapNode
Get
Dim currentUrl As String = FindCurrentUrl()
' Find the SiteMapNode that represents the current page.
Dim aCurrentNode As SiteMapNode = FindSiteMapNode(currentUrl)
Return aCurrentNode
End Get
End Property
' Implement the RootNode property.
Public Overrides ReadOnly Property RootNode() As SiteMapNode
Get
Return aRootNode
End Get
End Property
' Implement the ParentProvider property.
Public Overrides Property ParentProvider() As SiteMapProvider
Get
Return parentSiteMapProvider
End Get
Set(ByVal value As SiteMapProvider)
parentSiteMapProvider = Value
End Set
End Property
' Implement the RootProvider property.
Public Overrides ReadOnly Property RootProvider() As SiteMapProvider
Get
' If the current instance belongs to a provider hierarchy, it
' cannot be the RootProvider. Rely on the ParentProvider.
If Not (Me.ParentProvider Is Nothing) Then
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 Me
End If
End Get
End Property
' Implement the FindSiteMapNode method.
Public Overrides Function FindSiteMapNode(ByVal rawUrl As String) As SiteMapNode
' Does the root node match the URL?
If RootNode.Url = rawUrl Then
Return RootNode
Else
Dim candidate As SiteMapNode = Nothing
' Retrieve the SiteMapNode that matches the URL.
SyncLock Me
candidate = GetNode(siteMapNodes, rawUrl)
End SyncLock
Return candidate
End If
End Function 'FindSiteMapNode
' Implement the GetChildNodes method.
Public Overrides Function GetChildNodes(ByVal node As SiteMapNode) As SiteMapNodeCollection
Dim children As New SiteMapNodeCollection()
' Iterate through the ArrayList and find all nodes that have the specified node as a parent.
SyncLock Me
Dim i As Integer
For i = 0 To childParentRelationship.Count - 1
Dim de As DictionaryEntry = CType(childParentRelationship(i), DictionaryEntry)
Dim nodeUrl As String = CType(de.Key, String)
Dim parent As SiteMapNode = GetNode(childParentRelationship, nodeUrl)
If Not (parent Is Nothing) AndAlso node.Url = parent.Url Then
' The SiteMapNode with the Url that corresponds to nodeUrl
' is a child of the specified node. Get the SiteMapNode for
' the nodeUrl.
Dim child As SiteMapNode = FindSiteMapNode(nodeUrl)
If Not (child Is Nothing) Then
children.Add(CType(child, SiteMapNode))
Else
Throw New Exception("ArrayLists not in sync.")
End If
End If
Next i
End SyncLock
Return children
End Function 'GetChildNodes
Protected Overrides Function GetRootNodeCore() As SiteMapNode
Return RootNode
End Function ' GetRootNodeCore()
' Implement the GetParentNode method.
Public Overrides Function GetParentNode(ByVal node As SiteMapNode) As SiteMapNode
' Check the childParentRelationship table and find the parent of the current node.
' If there is no parent, the current node is the RootNode.
Dim parent As SiteMapNode = Nothing
SyncLock Me
' Get the Value of the node in childParentRelationship
parent = GetNode(childParentRelationship, node.Url)
End SyncLock
Return parent
End Function 'GetParentNode
' Implement the ProviderBase.Initialize method.
' Initialize is used to initialize the state that the Provider holds, but
' not actually build the site map.
Public Overrides Sub Initialize(ByVal name As String, ByVal attributes As NameValueCollection)
SyncLock Me
MyBase.Initialize(name, attributes)
simpleTextProviderName = name
sourceFilename = attributes("siteMapFile")
siteMapNodes = New ArrayList()
childParentRelationship = New ArrayList()
' Build the site map in memory.
LoadSiteMapFromStore()
End SyncLock
End Sub
' Private helper methods
Private Function GetNode(ByVal list As ArrayList, ByVal url As String) As SiteMapNode
Dim i As Integer
For i = 0 To list.Count - 1
Dim item As DictionaryEntry = CType(list(i), DictionaryEntry)
If CStr(item.Key) = url Then
Return CType(item.Value, SiteMapNode)
End If
Next i
Return Nothing
End Function 'GetNode
' Get the URL of the currently displayed page.
Private Function FindCurrentUrl() As String
Try
' The current HttpContext.
Dim currentContext As HttpContext = HttpContext.Current
If Not (currentContext Is Nothing) Then
Return currentContext.Request.RawUrl
Else
Throw New Exception("HttpContext.Current is Invalid")
End If
Catch e As Exception
Throw New NotSupportedException("This provider requires a valid context.", e)
End Try
End Function 'FindCurrentUrl
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
End Namespace
Keterangan
Kelas StaticSiteMapProvider dan XmlSiteMapProvider mewakili implementasi default dari kelas abstrak SiteMapProvider . XmlSiteMapProvider menggunakan file XML bernama Web.sitemap untuk menyimpan data peta situs. Untuk informasi selengkapnya tentang file Web.sitemap, lihat ASP.NET Peta Situs.
Kelas SiteMapProvider ini mendukung konsep hierarki penyedia peta situs, dengan mendeklarasikan RootProvider properti dan ParentProvider . SiteMapProvider bisa menjadi anak atau induk dari penyedia lain. Ini memungkinkan skenario di mana area konten yang berbeda dari situs dimiliki atau diimplementasikan oleh grup pengembangan berbeda yang mempertahankan peta situs dan penyedia peta situs mereka sendiri.
Semua SiteMapProvider objek dikonfigurasi dalam file Web.config. Setiap penyedia peta situs yang dinyatakan dalam file konfigurasi ini dimuat pada durasi dan digunakan untuk memuat dan memproses data navigasi situs. Objek SiteMap , yang melacak semua penyedia yang tersedia untuk itu melalui koleksi propertinya Providers , menyediakan akses terprogram ke data navigasi yang dikelola oleh penyedia. Contoh kode berikut menunjukkan format yang digunakan untuk mendeklarasikan penyedia peta situs dalam file Web.config.
<siteMap defaultProvider="<name>">
<providers>
<add
name="<friendly name>"
type="<fully qualified class name>, <assembly name (optional)>"
siteMapFile = "<file name>" />
</providers>
</siteMap>
Data navigasi situs yang dimuat oleh penyedia ini digunakan oleh komponen lain dari infrastruktur peta situs, seperti SiteMapPath kontrol dan TreeView , untuk menampilkan informasi peta situs bagi pengguna.
Jika Anda menerapkan penyedia peta situs Anda sendiri, Anda dapat menempatkan file sumber di direktori App_Code aplikasi ASP.NET Anda, dan kemudian perakitan akan dikompilasi secara otomatis. Anda juga dapat menempatkan penyedia peta situs Anda sendiri di Global Assembly Cache (GAC), dan memberikan referensi yang sepenuhnya memenuhi syarat untuk itu dalam file Web.config. Untuk informasi selengkapnya tentang layanan pengkompilasi, lihat Bekerja dengan Assembly dan Global Assembly Cache.
Catatan Bagi Implementer
Ketika Anda mewarisi dari SiteMapProvider kelas , Anda harus mengambil alih anggota berikut: GetRootNodeCore(), , FindSiteMapNode(String)GetChildNodes(SiteMapNode), dan GetParentNode(SiteMapNode).
Konstruktor
| SiteMapProvider() |
Menginisialisasi instans baru kelas SiteMapProvider. |
Properti
| CurrentNode |
SiteMapNode Mendapatkan objek yang mewakili halaman yang saat ini diminta. |
| Description |
Mendapatkan deskripsi singkat dan ramah yang cocok untuk ditampilkan di alat administratif atau antarmuka pengguna (UI) lainnya. (Diperoleh dari ProviderBase) |
| EnableLocalization |
Mendapatkan atau menetapkan nilai Boolean yang menunjukkan apakah nilai SiteMapNode atribut yang dilokalkan dikembalikan. |
| Name |
Mendapatkan nama ramah yang digunakan untuk merujuk ke penyedia selama konfigurasi. (Diperoleh dari ProviderBase) |
| ParentProvider |
Mendapatkan atau mengatur objek induk SiteMapProvider penyedia saat ini. |
| ResourceKey |
Mendapatkan atau mengatur kunci sumber daya yang digunakan untuk melokalisasi SiteMapNode atribut. |
| RootNode |
Mendapatkan objek akar SiteMapNode dari data peta situs yang diwakili penyedia saat ini. |
| RootProvider |
Mendapatkan objek akar SiteMapProvider dalam hierarki penyedia saat ini. |
| SecurityTrimmingEnabled |
Mendapatkan nilai Boolean yang menunjukkan apakah penyedia peta situs memfilter simpul peta situs berdasarkan peran pengguna. |
Metode
| AddNode(SiteMapNode) |
SiteMapNode Menambahkan objek ke kumpulan simpul yang dikelola oleh penyedia peta situs. |
| AddNode(SiteMapNode, SiteMapNode) |
SiteMapNode Menambahkan objek ke kumpulan simpul yang dikelola oleh penyedia peta situs dan menentukan objek indukSiteMapNode. |
| Equals(Object) |
Menentukan apakah objek yang ditentukan sama dengan objek saat ini. (Diperoleh dari Object) |
| FindSiteMapNode(HttpContext) |
SiteMapNode Mengambil objek yang mewakili halaman yang saat ini diminta menggunakan objek yang ditentukanHttpContext. |
| FindSiteMapNode(String) |
Saat ditimpa di kelas turunan SiteMapNode , mengambil objek yang mewakili halaman di URL yang ditentukan. |
| FindSiteMapNodeFromKey(String) |
SiteMapNode Mengambil objek berdasarkan kunci tertentu. |
| GetChildNodes(SiteMapNode) |
Ketika ditimpa di kelas turunan, mengambil simpul anak dari tertentu SiteMapNode. |
| GetCurrentNodeAndHintAncestorNodes(Int32) |
Menyediakan metode pencarian yang dioptimalkan untuk penyedia peta situs saat mengambil simpul untuk halaman yang saat ini diminta dan mengambil simpul peta situs induk dan leluhur untuk halaman saat ini. |
| GetCurrentNodeAndHintNeighborhoodNodes(Int32, Int32) |
Menyediakan metode pencarian yang dioptimalkan untuk penyedia peta situs saat mengambil simpul untuk halaman yang saat ini diminta dan mengambil simpul peta situs di dekat simpul saat ini. |
| GetHashCode() |
Berfungsi sebagai fungsi hash default. (Diperoleh dari Object) |
| GetParentNode(SiteMapNode) |
Ketika ditimpa di kelas turunan, mengambil simpul induk dari objek tertentu SiteMapNode . |
| GetParentNodeRelativeToCurrentNodeAndHintDownFromParent(Int32, Int32) |
Menyediakan metode pencarian yang dioptimalkan untuk penyedia peta situs saat mengambil simpul leluhur untuk halaman yang saat ini diminta dan mengambil simpul turunan untuk leluhur. |
| GetParentNodeRelativeToNodeAndHintDownFromParent(SiteMapNode, Int32, Int32) |
Menyediakan metode pencarian yang dioptimalkan untuk penyedia peta situs saat mengambil simpul leluhur untuk objek yang ditentukan SiteMapNode dan mengambil simpul anaknya. |
| GetRootNodeCore() |
Ketika ditimpa di kelas turunan, mengambil simpul akar dari semua simpul yang saat ini dikelola oleh penyedia saat ini. |
| GetRootNodeCoreFromProvider(SiteMapProvider) |
Mengambil simpul akar dari semua simpul yang saat ini dikelola oleh penyedia peta situs yang ditentukan. |
| GetType() |
Mendapatkan dari instans Type saat ini. (Diperoleh dari Object) |
| HintAncestorNodes(SiteMapNode, Int32) |
Menyediakan metode yang dapat diambil alih penyedia peta situs untuk melakukan pengambilan yang dioptimalkan dari satu atau beberapa tingkat simpul induk dan leluhur, relatif terhadap objek yang ditentukan SiteMapNode . |
| HintNeighborhoodNodes(SiteMapNode, Int32, Int32) |
Menyediakan metode yang dapat diambil alih penyedia peta situs untuk melakukan pengambilan simpul yang dioptimalkan yang ditemukan di kedekatan simpul yang ditentukan. |
| Initialize(String, NameValueCollection) |
Menginisialisasi SiteMapProvider implementasi, termasuk sumber daya apa pun yang diperlukan untuk memuat data peta situs dari penyimpanan persisten. |
| IsAccessibleToUser(HttpContext, SiteMapNode) |
Mengambil nilai Boolean yang menunjukkan apakah objek yang ditentukan SiteMapNode dapat dilihat oleh pengguna dalam konteks yang ditentukan. |
| MemberwiseClone() |
Membuat salinan dangkal dari saat ini Object. (Diperoleh dari Object) |
| RemoveNode(SiteMapNode) |
Menghapus objek yang ditentukan SiteMapNode dari kumpulan simpul yang dikelola oleh penyedia peta situs. |
| ResolveSiteMapNode(HttpContext) |
Memunculkan kejadian SiteMapResolve. |
| ToString() |
Mengembalikan string yang mewakili objek saat ini. (Diperoleh dari Object) |
Acara
| SiteMapResolve |
Terjadi ketika CurrentNode properti dipanggil. |
