SiteMapProvider クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
すべてのサイト マップ データ プロバイダーの共通基本クラスを提供します。また、SiteMap オブジェクトの永続記憶領域として ASP.NET サイト マップ インフラストラクチャと組み合わせて使用できるカスタム サイト マップ データ プロバイダーを開発者が実装する手段を提供します。
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- 継承
- 派生
例
次のコード例では、抽象 SiteMapProvider クラスを実装するクラスを記述する方法を示します。 この例には、サンプル SiteMapProvider と、それに対応するサンプル テキスト ファイルのみが含まれています。 この例を実行するには、Web.config ファイルと.aspx ページにもエントリが必要です。 これらは、 プロパティのドキュメント SiteMapDataSource.SiteMapProvider で確認できます。
この例では、想定される構造に従ってコンマ区切りのファイルを使用して、サイトマップ情報を読み込みます。 ファイルの最初の行はサイトマップのルート ノードを表し、後続の行はサブノードです。 各サブノードは、その親ノードを URL で識別します。 これらの条件を満たすファイルの例を次に示します。
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 、すべてのプロパティとメソッドの実装例が SiteMapProvider 用意されています。
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
注釈
クラスと XmlSiteMapProvider クラスはStaticSiteMapProvider、抽象SiteMapProviderクラスの既定の実装を表します。 では XmlSiteMapProvider 、Web.sitemap という名前の XML ファイルを使用してサイト マップ データを格納します。 Web.sitemap ファイルの詳細については、「 サイト マップの ASP.NET」を参照してください。
クラスはSiteMapProvider、 プロパティと ParentProvider プロパティを宣言することで、サイト マップ プロバイダー階層のRootProvider概念をサポートします。 には SiteMapProvider 、別のプロバイダーの子または親を指定できます。 これにより、サイトのさまざまなコンテンツ領域が、独自のサイト マップとサイト マップ プロバイダーを維持するさまざまな開発グループによって所有または実装されるシナリオが可能になります。
すべての SiteMapProvider オブジェクトは、Web.config ファイルで構成されます。 これらの構成ファイルで宣言されているサイト マップ プロバイダーは、実行時に読み込まれ、サイト ナビゲーション データの読み込みと処理に使用されます。 プロパティ コレクションを通じてProviders使用可能なすべてのプロバイダーを追跡する オブジェクトはSiteMap、プロバイダーによって管理されるナビゲーション データへのプログラムによるアクセスを提供します。 次のコード例は、Web.config ファイルでサイト マップ プロバイダーを宣言するために使用される形式を示しています。
<siteMap defaultProvider="<name>">
<providers>
<add
name="<friendly name>"
type="<fully qualified class name>, <assembly name (optional)>"
siteMapFile = "<file name>" />
</providers>
</siteMap>
これらのプロバイダーによって読み込まれるサイト ナビゲーション データは、 コントロールや TreeView コントロールなどのSiteMapPathサイト マップ インフラストラクチャの他のコンポーネントによって、ユーザーのサイト マップ情報を表示するために使用されます。
独自のサイト マップ プロバイダーを実装する場合は、ASP.NET アプリケーションのApp_Code ディレクトリにソース ファイルを配置すると、アセンブリが自動的にコンパイルされます。 また、独自のサイト マップ プロバイダーをグローバル アセンブリ キャッシュ (GAC) に配置し、そのプロバイダーへの完全修飾参照を Web.config ファイルに提供することもできます。 コンパイラ サービスの詳細については、「 アセンブリとグローバル アセンブリ キャッシュの操作」を参照してください。
注意 (実装者)
クラスからSiteMapProvider継承する場合は、、、、および GetParentNode(SiteMapNode)の各メンバーGetRootNodeCore()FindSiteMapNode(String)GetChildNodes(SiteMapNode)をオーバーライドする必要があります。
コンストラクター
| SiteMapProvider() |
SiteMapProvider クラスの新しいインスタンスを初期化します。 |
プロパティ
| CurrentNode |
現在要求されているページを表す SiteMapNode オブジェクトを取得します。 |
| Description |
管理ツールまたは他のユーザー インターフェイス (UI) での表示に適した、簡単でわかりやすい説明を取得します。 (継承元 ProviderBase) |
| EnableLocalization |
SiteMapNode 属性のローカライズされた値が返されるかどうかを示すブール値を取得または設定します。 |
| Name |
構成時にプロバイダーを参照するために使用される表示名を取得します。 (継承元 ProviderBase) |
| ParentProvider |
現在のプロバイダーの親 SiteMapProvider オブジェクトを取得または設定します。 |
| ResourceKey |
SiteMapNode 属性のローカライズに使用するリソース キーを取得または設定します。 |
| RootNode |
現在のプロバイダーが示すサイト マップ データのルート SiteMapNode オブジェクトを取得します。 |
| RootProvider |
現在のプロバイダー階層のルート SiteMapProvider オブジェクトを取得します。 |
| SecurityTrimmingEnabled |
サイト マップ プロバイダーがユーザーのロールに基づいてサイト マップ ノードをフィルター処理するかどうかを示すブール値を取得します。 |
メソッド
| AddNode(SiteMapNode) |
サイト マップ プロバイダーが管理するノード コレクションに SiteMapNode オブジェクトを追加します。 |
| AddNode(SiteMapNode, SiteMapNode) |
サイト マップ プロバイダーが管理するノード コレクションに SiteMapNode オブジェクトを追加し、親 SiteMapNode オブジェクトを指定します。 |
| Equals(Object) |
指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object) |
| FindSiteMapNode(HttpContext) |
現在要求されているページを表す SiteMapNode オブジェクトを、指定した HttpContext オブジェクトを使用して取得します。 |
| FindSiteMapNode(String) |
派生クラスでオーバーライドされた場合は、指定した URL のページを表す SiteMapNode オブジェクトを取得します。 |
| FindSiteMapNodeFromKey(String) |
指定したキーに基づいて SiteMapNode オブジェクトを取得します。 |
| GetChildNodes(SiteMapNode) |
派生クラスでオーバーライドされた場合は、特定の SiteMapNode の子ノードを取得します。 |
| GetCurrentNodeAndHintAncestorNodes(Int32) |
現在要求されているページのノードを取得し、現在のページの親および先祖のサイト マップ ノードをフェッチする際、サイト マップ プロバイダーに最適化された検索メソッドを提供します。 |
| GetCurrentNodeAndHintNeighborhoodNodes(Int32, Int32) |
現在要求されているページのノードを検索し、現在のノードの近くのサイト マップ ノードをフェッチする際、サイト マップ プロバイダーに最適化された検索メソッドを提供します。 |
| GetHashCode() |
既定のハッシュ関数として機能します。 (継承元 Object) |
| GetParentNode(SiteMapNode) |
派生クラスでオーバーライドされた場合は、特定の SiteMapNode オブジェクトの親ノードを取得します。 |
| GetParentNodeRelativeToCurrentNodeAndHintDownFromParent(Int32, Int32) |
現在要求されているページの先祖ノードを取得し、その先祖の子孫ノードをフェッチする際、サイト マップ プロバイダーに最適化された検索メソッドを提供します。 |
| GetParentNodeRelativeToNodeAndHintDownFromParent(SiteMapNode, Int32, Int32) |
指定した SiteMapNode オブジェクトの先祖ノードを取得して、その子ノードをフェッチする際に、サイト マップ プロバイダーに最適化された検索メソッドを提供します。 |
| GetRootNodeCore() |
派生クラスでオーバーライドされた場合は、現在のプロバイダーによって現在管理されている全ノードのルート ノードを取得します。 |
| GetRootNodeCoreFromProvider(SiteMapProvider) |
指定したサイト マップ プロバイダーによって現在管理されているすべてのノードのルート ノードを取得します。 |
| GetType() |
現在のインスタンスの Type を取得します。 (継承元 Object) |
| HintAncestorNodes(SiteMapNode, Int32) |
サイト マップ プロバイダーがオーバーライドして、指定した SiteMapNode オブジェクトの相対として 1 つ以上のレベルの親ノードと先祖ノードの最適化された取得を実行できるメソッドを提供します。 |
| HintNeighborhoodNodes(SiteMapNode, Int32, Int32) |
サイト マップ プロバイダーがオーバーライドして、指定したノードの近くで見つかったノードの最適化された取得を実行できるメソッドを提供します。 |
| Initialize(String, NameValueCollection) |
SiteMapProvider 実装を初期化します。対象には、サイト マップ データを永続ストレージから読み込むために必要なリソースがすべて含まれます。 |
| IsAccessibleToUser(HttpContext, SiteMapNode) |
指定した SiteMapNode オブジェクトを、指定したコンテキストでユーザーが表示できるかどうかを示すブール値を取得します。 |
| MemberwiseClone() |
現在の Object の簡易コピーを作成します。 (継承元 Object) |
| RemoveNode(SiteMapNode) |
指定された SiteMapNode オブジェクトを、サイト マップ プロバイダーが管理するノード コレクションから削除します。 |
| ResolveSiteMapNode(HttpContext) |
SiteMapResolve イベントを発生させます。 |
| ToString() |
現在のオブジェクトを表す文字列を返します。 (継承元 Object) |
イベント
| SiteMapResolve |
CurrentNode プロパティが呼び出されると発生します。 |
適用対象
こちらもご覧ください
.NET