SiteMapNodeCollection.Add メソッドとは何？わかりやすく解説 Weblio辞書

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

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

SiteMapNodeCollection.Add メソッド

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

単一の SiteMapNode オブジェクトをコレクションに追加します。

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

Visual Basic (宣言)

Public Overridable Function
 Add ( _
    value As SiteMapNode _
) As Integer

Visual Basic (使用法)

Dim instance As SiteMapNodeCollection
Dim value As SiteMapNode
Dim returnValue As Integer

returnValue = instance.Add(value)

public virtual int Add (
    SiteMapNode value
)

C++

public:
virtual int Add (
    SiteMapNode^ value
)

public int Add (
    SiteMapNode value
)

JScript

public function Add (
    value : SiteMapNode
) : int

パラメータ

value: SiteMapNodeCollection に追加する SiteMapNode。

戻り値
SiteMapNode が挿入された InnerList のインデックス。

例外

例外の種類	条件
ArgumentException	value が null 参照 (Visual Basic では Nothing) です。
NotSupportedException	SiteMapNodeCollection は読み取り専用です。

解説

SiteMapNode オブジェクトを読み取り専用または固定サイズの SiteMapNodeCollection コレクションに追加することはできません。IsReadOnly プロパティをチェックすることにより、SiteMapNodeCollection が読み取り専用であるかどうかをテストできます。

使用例

このセクションには、2 つのコード例が含まれています。新しい SiteMapNodeCollection コレクションを作成して、それに要素を追加する方法を最初のコード例に示します。要素をカスタムサイトマッププロバイダに追加する方法を 2 番目のコード例に示します。

SiteMapNodeCollection コンストラクタを使用して新しい SiteMapNodeCollection を作成し、Add メソッドを使用して要素をそれに追加する方法を次のコード例に示します。

Visual Basic

' The LoadSiteMapData() Function loads site navigation
' data from persistent storage into a DataTable.

Dim siteMapData As DataTable
siteMapData = LoadSiteMapData()

' Create a SiteMapNodeCollection.
Dim nodes As New SiteMapNodeCollection()

' Create a SiteMapNode and add it to the collection.
Dim tempNode As SiteMapNode
Dim row As DataRow
Dim index As Integer
index = 0

While (index < siteMapData.Rows.Count)

    row = siteMapData.Rows(index)

    ' Create a node based on the data in the DataRow.
    tempNode = New SiteMapNode(SiteMap.Provider, row("Key").ToString(),
 row("Url").ToString())

    ' Add the node to the collection.
    nodes.Add(tempNode)
    index = index + 1
End While

// The LoadSiteMapData() method loads site navigation
// data from persistent storage into a DataTable.
DataTable siteMap = LoadSiteMapData();

// Create a SiteMapNodeCollection.
SiteMapNodeCollection nodes = new SiteMapNodeCollection();

// Create a SiteMapNode and add it to the collection.
SiteMapNode tempNode;
DataRow row;
int index = 0;

while (index < siteMap.Rows.Count)
{

    row = siteMap.Rows[index];

    // Create a node based on the data in the DataRow.
    tempNode = new SiteMapNode(SiteMap.Provider,
                                row["Key"].ToString(),
                                row["Url"].ToString());

    // Add the node to the collection.
    nodes.Add(tempNode);
    ++index;
}

カスタムサイトマッププロバイダの実装方法、および SiteMapNodeCollection コンストラクタを使用して新しい SiteMapNodeCollection を作成し、Add メソッドを使用して要素を SiteMapNodeCollection に追加する方法を次のコード例に示します。

このコード例は、SiteMapProvider クラスのトピックで取り上げている、コード例の一部分です。

Visual Basic

' 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 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;
}