SiteMapNodeCollection クラスとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

SiteMapNodeCollection クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

SiteMapNode オブジェクトの厳密に型指定されたコレクションを提供し、コレクションのナビゲーションをサポートするための IHierarchicalEnumerable インターフェイスを実装します。

名前空間: System.Web
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Class SiteMapNodeCollection
    Implements IHierarchicalEnumerable, IList, ICollection, IEnumerable

Visual Basic (使用法)

Dim instance As SiteMapNodeCollection

public class SiteMapNodeCollection : IHierarchicalEnumerable,
 IList, ICollection, 
    IEnumerable

C++

public ref class SiteMapNodeCollection : IHierarchicalEnumerable,
 IList, ICollection, 
    IEnumerable

public class SiteMapNodeCollection implements
 IHierarchicalEnumerable, IList, 
    ICollection, IEnumerable

JScript

public class SiteMapNodeCollection implements
 IHierarchicalEnumerable, IList, 
    ICollection, IEnumerable

解説

SiteMapNodeCollection クラスは、SiteMapNode オブジェクトの厳密に型指定されたコレクションを提供します。また、SiteMapNode オブジェクトをインデックス番号が 0 から始まる配列に内部的に格納します。

SiteMapNodeCollection コレクションは、最初に作成するときに変更できます。その後、次のメソッドを使用して SiteMapNode オブジェクトの追加、コピー、および削除ができます。

SiteMapNode オブジェクトを追加するには、Add、AddRange、Insert の各メソッドを使用します。
SiteMapNode オブジェクトをコピーするには、CopyTo メソッドを使用します。
SiteMapNode オブジェクトを削除するには、Remove メソッドを使用します。

読み取り専用の SiteMapNodeCollection を作成できます。これに対する SiteMapNode オブジェクトの追加、コピー、または削除はできません。作成には、静的な ReadOnly メソッドを使用します。メソッド SiteMapNode.GetAllNodes および GetChildren によって返される SiteMapNodeCollection コレクションは、読み取り専用です。プロバイダから返された SiteMapNode オブジェクト上で ChildNodes プロパティがアクセスされたときに返される SiteMapNodeCollection も同様です。既定のインデクサプロパティを設定するか、次のメソッドのどれかを使用して、読み取り専用の SiteMapNodeCollection を変更しようとすると、NotSupportedException 例外がスローされます。

Add
AddRange
Clear
Insert
Remove
RemoveAt

上記にリストされているメソッドのどれかを呼び出す前に、IsReadOnly プロパティを使用してコレクションを確認してください。

使用例

SiteMapNodeCollection コレクションを作成し、AddRange メソッドを使用して、それに SiteMapNode オブジェクトを追加する方法を次のコード例に示します。SiteMapNodeCollection は、現在のサイトマップのサブセットで、上位 2 階層レベルのみ表示します。

Visual Basic

' Create a SiteMapNodeCollection with all the nodes
' from the first two hierarchical levels of the current
' site map.
Dim baseCollection As SiteMapNodeCollection
baseCollection = New SiteMapNodeCollection(SiteMap.RootNode)

Dim childCollection As SiteMapNodeCollection
 = SiteMap.RootNode.ChildNodes

baseCollection.AddRange(childCollection)

Response.Write( "<BR>Derived SiteMapNodeCollection.<BR><HR><BR>")

For Each node In baseCollection
    Response.Write( node.Title + "<BR>")
Next

// Create a SiteMapNodeCollection with all the nodes
// from the first two hierarchical levels of the current
// site map.
SiteMapNodeCollection baseCollection =
    new SiteMapNodeCollection(SiteMap.RootNode);

SiteMapNodeCollection childCollection =
    SiteMap.RootNode.ChildNodes;

baseCollection.AddRange(childCollection);

Response.Write( "<BR>Derived SiteMapNodeCollection.<BR><HR><BR>");
foreach (SiteMapNode node in baseCollection)
 {
    Response.Write( node.Title + "<BR>");
}