Edit

TreeNodeBindingCollection.Add(TreeNodeBinding) Method

  • Reference

Definition

Namespace:
System.Web.UI.WebControls
Assembly:
System.Web.dll

Appends the specified TreeNodeBinding object to the end of the TreeNodeBindingCollection object.

public:
 int Add(System::Web::UI::WebControls::TreeNodeBinding ^ binding);
public int Add (System.Web.UI.WebControls.TreeNodeBinding binding);
member this.Add : System.Web.UI.WebControls.TreeNodeBinding -> int
Public Function Add (binding As TreeNodeBinding) As Integer

Parameters

binding
TreeNodeBinding

The TreeNodeBinding to append.

Returns

Int32

The zero-based index of the location of the added TreeNodeBinding in the TreeNodeBindingCollection.

Examples

The following code example demonstrates how to use the Add method to add a new TreeNodeBinding object programmatically to a TreeNodeBindingCollection object. For this example to work correctly, you must copy the XML data that is located at the end of this section to a file called Book.xml.


<%@ Page Language="C#" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

  void Page_Load(Object sender, EventArgs e)
  {

    // Use the Remove method to remove the TreeNodeBinding object
    // for the third-level nodes (index 2).
    TreeNodeBinding oldBinding = BookTreeView.DataBindings[2];
    BookTreeView.DataBindings.Remove(oldBinding);

    // Create a new TreeNodeBinding object and set its properties.
    TreeNodeBinding newBinding = new TreeNodeBinding();
    newBinding.DataMember = "Section";
    newBinding.TextField = "Subject";

    // Use the Add method to add the TreeNodeBinding object to the 
    // DataBindings collection.
    BookTreeView.DataBindings.Add(newBinding);

  }

</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>TreeNodeBindingCollection Add and Remove Example</title>
</head>
<body>
    <form id="form1" runat="server">
    
      <h3>TreeNodeBindingCollection Add and Remove Example</h3>
    
      <asp:TreeView id="BookTreeView" 
        DataSourceID="BookXmlDataSource"
        runat="server">
         
        <DataBindings>
          <asp:TreeNodeBinding DataMember="Book" TextField="Title"/>
          <asp:TreeNodeBinding DataMember="Chapter" TextField="Heading"/>
          <asp:TreeNodeBinding DataMember="Section" TextField="Heading"/>
        </DataBindings>
         
      </asp:TreeView>

      <asp:XmlDataSource id="BookXmlDataSource"  
        DataFile="Book.xml"
        runat="server">
      </asp:XmlDataSource>
    
    </form>
  </body>
</html>


<%@ Page Language="VB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

  Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)

    ' Use the Remove method to remove the TreeNodeBinding object
    ' for the third-level nodes (index 2).
    Dim oldBinding As TreeNodeBinding = BookTreeView.DataBindings(2)
    BookTreeView.DataBindings.Remove(oldBinding)

    ' Create a new TreeNodeBinding object and set its properties.
    Dim newBinding As TreeNodeBinding = New TreeNodeBinding
    newBinding.DataMember = "Section"
    newBinding.TextField = "Subject"

    ' Use the Add method to add the TreeNodeBinding object to the 
    ' DataBindings collection.
    BookTreeView.DataBindings.Add(newBinding)

  End Sub

</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>TreeNodeBindingCollection Add and Remove Example</title>
</head>
<body>
    <form id="form1" runat="server">
    
      <h3>TreeNodeBindingCollection Add and Remove Example</h3>
    
      <asp:TreeView id="BookTreeView" 
        DataSourceID="BookXmlDataSource"
        runat="server">
         
        <DataBindings>
          <asp:TreeNodeBinding DataMember="Book" TextField="Title"/>
          <asp:TreeNodeBinding DataMember="Chapter" TextField="Heading"/>
          <asp:TreeNodeBinding DataMember="Section" TextField="Heading"/>
        </DataBindings>
         
      </asp:TreeView>

      <asp:XmlDataSource id="BookXmlDataSource"  
        DataFile="Book.xml"
        runat="server">
      </asp:XmlDataSource>
    
    </form>
  </body>
</html>

The following is the XML data for the preceding code example.

<Book Title="Book Title">  
    <Chapter Heading="Chapter 1">  
        <Section Heading="Section 1"  
            Subject="Subject 1">  
        </Section>  
        <Section Heading="Section 2"  
            Subject="Subject 1">  
        </Section>  
    </Chapter>  
    <Chapter Heading="Chapter 2">  
        <Section Heading="Section 1"  
            Subject="Subject 1">  
        </Section>  
    </Chapter>  
</Book>

Remarks

Use the Add method to append the specified TreeNodeBinding object to the end of the TreeNodeBindingCollection object.

As an alternative, you can insert a TreeNodeBinding object in the TreeNodeBindingCollection at a specific index using the Insert method.

Applies to

See also