SiteMap.SiteMapResolve イベント

定義

CurrentNode プロパティがアクセスされると発生します。

public:
 static event System::Web::SiteMapResolveEventHandler ^ SiteMapResolve;
public static event System.Web.SiteMapResolveEventHandler SiteMapResolve;
member this.SiteMapResolve : System.Web.SiteMapResolveEventHandler 
Public Shared Custom Event SiteMapResolve As SiteMapResolveEventHandler 

イベントの種類

次のコード例では、ASP.NET Web ページでイベントを SiteMapResolve 処理して、サイト ナビゲーション コントロールによって表示されるターゲット URL (コントロールなど) を変更する方法を SiteMapPath 示します。 この例では、現在のページはオンライン掲示板またはフォーラムの投稿ページです。 より意味のあるサイト ナビゲーションをレンダリングするために、ナビゲーション コントロールによって表示されるノードの URL にコンテキスト関連のクエリ文字列が追加されます。

Note

ASP.NET サイト ナビゲーション インフラストラクチャは、無限再帰から保護します。これにより、セーフガードが提供され、クラス内から プロパティへのアクセスに関連する CurrentNode セキュリティ リスクが最小限に SiteMapResolveEventHandler 抑えられます。

次のコードは Global.asax ファイルに属しています。 イベント ハンドラーは、アプリケーションに対して 1 回だけアタッチされます。 このコードは、ページが インターフェイスを実装 ISiteMapResolver しているかどうかを認識します。 インターフェイスが実装されている場合は、 関数が ExpandForumPaths 呼び出されます。

private void Page_Load(object sender, EventArgs e)
{
    // The ExpandForumPaths method is called to handle
    // the SiteMapResolve event.
    SiteMap.SiteMapResolve +=
      new SiteMapResolveEventHandler(this.ExpandForumPaths);
}

private SiteMapNode ExpandForumPaths(Object sender, SiteMapResolveEventArgs e)
{
    // The current node represents a Post page in a bulletin board forum.
    // Clone the current node and all of its relevant parents. This
    // returns a site map node that a developer can then
    // walk, modifying each node.Url property in turn.
    // Since the cloned nodes are separate from the underlying
    // site navigation structure, the fixups that are made do not
    // effect the overall site navigation structure.
    SiteMapNode currentNode = SiteMap.CurrentNode.Clone(true);
    SiteMapNode tempNode = currentNode;

    // Obtain the recent IDs.
    int forumGroupID = GetMostRecentForumGroupID();
    int forumID = GetMostRecentForumID(forumGroupID);
    int postID = GetMostRecentPostID(forumID);

    // The current node, and its parents, can be modified to include
    // dynamic querystring information relevant to the currently
    // executing request.
    if (0 != postID)
    {
        tempNode.Url = tempNode.Url + "?PostID=" + postID.ToString();
    }

    if ((null != (tempNode = tempNode.ParentNode)) &&
        (0 != forumID))
    {
        tempNode.Url = tempNode.Url + "?ForumID=" + forumID.ToString();
    }

    if ((null != (tempNode = tempNode.ParentNode)) &&
        (0 != forumGroupID))
    {
        tempNode.Url = tempNode.Url + "?ForumGroupID=" + forumGroupID.ToString();
    }

    return currentNode;
}
Private Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)

    ' The ExpandForumPaths method is called to handle
    ' the SiteMapResolve event.
    AddHandler SiteMap.SiteMapResolve, AddressOf Me.ExpandForumPaths

End Sub

Private Function ExpandForumPaths(ByVal sender As Object, ByVal e As SiteMapResolveEventArgs) As SiteMapNode
    ' The current node represents a Post page in a bulletin board forum.
    ' Clone the current node and all of its relevant parents. This
    ' returns a site map node that a developer can then
    ' walk, modifying each node.Url property in turn.
    ' Since the cloned nodes are separate from the underlying
    ' site navigation structure, the fixups that are made do not
    ' effect the overall site navigation structure.
    Dim currentNode As SiteMapNode = SiteMap.CurrentNode.Clone(True)
    Dim tempNode As SiteMapNode = currentNode

    ' Obtain the recent IDs.
    Dim forumGroupID As Integer = GetMostRecentForumGroupID()
    Dim forumID As Integer = GetMostRecentForumID(forumGroupID)
    Dim postID As Integer = GetMostRecentPostID(forumID)

    ' The current node, and its parents, can be modified to include
    ' dynamic querystring information relevant to the currently
    ' executing request.
    If Not (0 = postID) Then
        tempNode.Url = tempNode.Url & "?PostID=" & postID.ToString()
    End If

    tempNode = tempNode.ParentNode
    If Not (0 = forumID) And Not (tempNode Is Nothing) Then
        tempNode.Url = tempNode.Url & "?ForumID=" & forumID.ToString()
    End If

    tempNode = tempNode.ParentNode
    If Not (0 = ForumGroupID) And Not (tempNode Is Nothing) Then
        tempNode.Url = tempNode.Url & "?ForumGroupID=" & forumGroupID.ToString()
    End If

    Return currentNode

End Function

次のコードでは、別のインターフェイスを定義します。 (Web サイト プロジェクトでは、このコードを App_Code フォルダーに配置できます)。インターフェイスは ISiteMapResolver メソッドを ExpandForumPaths 定義します。

// These methods are just placeholders for the example.
// One option is to use the HttpContext or e.Context object
// to obtain the ID.
private int GetMostRecentForumGroupID()
{
    return 24;
}

private int GetMostRecentForumID(int forumGroupId)
{
    return 128;
}

private int GetMostRecentPostID(int forumId)
{
    return 317424;
}
' These methods are just placeholders for the example.
' One option is to use the HttpContext or e.Context object
' to obtain the ID.
Private Function GetMostRecentForumGroupID() As Integer
    Return 24
End Function

Private Function GetMostRecentForumID(ByVal forumGroupId As Integer) As Integer
    Return 128
End Function

Private Function GetMostRecentPostID(ByVal forumId As Integer) As Integer
    Return 317424
End Function

次のコードは、サイト マップ構造の深い少なくとも 3 つのノードであるページに属しています。 ページは インターフェイスを ISiteMapResolver 実装します。これにより、 メソッドを ExpandForumPaths 呼び出できるようになります。

<asp:SiteMapPath
id="SiteMapPath1"
runat="server"
RenderCurrentNodeAsLink="true" />
<asp:SiteMapPath
id="SiteMapPath1"
runat="server"
RenderCurrentNodeAsLink="true" />

注釈

サブスクライバーは、 SiteMapResolveEventHandler プロパティにアクセスしたときに通知を受け取るオブジェクトを静的 SiteMapResolve イベントに CurrentNode アタッチします。 これにより、ユーザーは、カスタム プロバイダーの実装を SiteMapNode 必要とせずに、現在実行中のページの表現を作成するときにカスタム ロジックを実装できます。

イベントをサブスクライブする SiteMapResolve 場合は、既定の SiteMapResolve サイト マップ プロバイダーでもイベントをサブスクライブします。

適用対象

こちらもご覧ください