SiteMap.SiteMapResolve イベント

定義

CurrentNode プロパティがアクセスされると発生します。Occurs when the CurrentNode property is accessed.

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 イベントを処理して、サイトナビゲーションコントロール (SiteMapPath コントロールなど) によって表示されるターゲット Url を変更する方法を示しています。The following code example demonstrates how to handle the SiteMapResolve event on an ASP.NET Web page to modify the target URLs that are displayed by a site navigation control, such as the SiteMapPath control. この例では、現在のページはオンラインの掲示板またはフォーラムの投稿ページです。In this example, the current page is a post page in an online bulletin board or forum. 有意義なサイトナビゲーションを表示するために、ナビゲーションコントロールによって表示されるノードの Url に、関連するクエリ文字列が追加されます。In order to render more meaningful site navigation, the URLs of the nodes that are displayed by the navigation control are appended with context relevant query strings.

注意

ASP.NET サイトナビゲーションインフラストラクチャは無限再帰を防止します。これにより、セーフガードが提供され、SiteMapResolveEventHandler クラス内から CurrentNode プロパティへのアクセスに関連するセキュリティリスクが最小限に抑えられます。The ASP.NET site navigation infrastructure guards against infinite recursion, which provides a safeguard and minimizes the security risk that is associated with accessing the CurrentNode property from within the SiteMapResolveEventHandler class.

次のコードは、global.asax ファイルに含まれています。The following code belongs in the Global.asax file. イベントハンドラーは、アプリケーションに対して1回だけアタッチされます。The event handler will be attached only once for the application. このコードは、ページが ISiteMapResolver インターフェイスを実装しているかどうかを認識します。The code recognizes whether the page implements the ISiteMapResolver interface. インターフェイスが実装されている場合は、ExpandForumPaths 関数が呼び出されます。If the interface is implemented, the ExpandForumPaths function is called.

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

次のコードでは、別のインターフェイスを定義しています。The following code defines a separate interface. (Web サイトプロジェクトでは、このコードを App_Code フォルダーに置くことができます)。ISiteMapResolver インターフェイスは、ExpandForumPaths メソッドを定義します。(In a Web site project, you can put this code in the App_Code folder.) The ISiteMapResolver interface defines the ExpandForumPaths method.

// 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つのノードで構成されるページに属しています。The following code belongs with the page that is at least three nodes deep in the site-map structure. ページには ISiteMapResolver インターフェイスが実装されています。これにより、ExpandForumPaths メソッドを呼び出すことができます。The page implements the ISiteMapResolver interface, which enables the ExpandForumPaths method to be called.

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

注釈

サブスクライバーは、CurrentNode プロパティにアクセスしたときに通知を受信するために、SiteMapResolveEventHandler オブジェクトを静的 SiteMapResolve イベントにアタッチします。Subscribers attach a SiteMapResolveEventHandler object to the static SiteMapResolve event to receive notification when the CurrentNode property is accessed. これにより、カスタムプロバイダーの実装を必要とせずに、現在実行中のページの SiteMapNode 表現を作成するときに、ユーザーがカスタムロジックを実装できるようになります。This enables the user to implement custom logic when creating a SiteMapNode representation of the currently executing page without requiring a custom provider implementation.

SiteMapResolve イベントにサブスクライブする場合は、既定のサイトマッププロバイダーの SiteMapResolve イベントをサブスクライブすることもできます。If you subscribe to the SiteMapResolve event, you also subscribe to the SiteMapResolve event on the default site map provider.

適用対象

こちらもご覧ください