TreeView.PopulateNodesFromClient Property
Assembly: System.Web (in system.web.dll)
/** @property */ public boolean get_PopulateNodesFromClient () /** @property */ public void set_PopulateNodesFromClient (boolean value)
public function get PopulateNodesFromClient () : boolean public function set PopulateNodesFromClient (value : boolean)
Not applicable.
Property Value
true to populate tree node data on demand from the client; otherwise, false. The default is true.Sometimes, it is not practical to statically predefine the tree structure due to data size or custom content that depends on user input. Because of this, the TreeView control supports dynamic node population. When the PopulateOnDemand property for a node is set to true, that node gets populated at run time when the node is expanded.
In addition to populating nodes on demand, it is possible to populate the nodes directly on a supported client browser. When the PopulateNodesFromClient property is set to true, a service is called from the client to populate the tree nodes, which eliminates the need to post back to the server. Otherwise, the TreeView control posts back to the server to populate the nodes.
Note: |
|---|
| The EnableClientScript property must also be set to true in order for the PopulateNodesFromClient property to be set to true. |
To populate a node on the client, first set the PopulateNodesFromClient property to true and then set the PopulateOnDemand property for the node to true. Next, define an event-handling method for the TreeNodePopulate event that programmatically populates the node. A typical event-handling method retrieves node data from a data source, places the data into a node structure, and then adds the node structure to the ChildNodes collection of the node being populated. You create a node structure by adding TreeNode objects to the ChildNodes collection of a parent node.
Note: |
|---|
| When the PopulateOnDemand property for a node is set to true, the node must be populated dynamically. You cannot declaratively nest another node below it; otherwise, an error will occur on the page. |
Note: |
|---|
| The client-side node population feature is supported only in Microsoft Internet Explorer version 5.5 and later and Netscape 6.0 and later. |
The value of this property is stored in view state.
The following code example demonstrates how to use the PopulateNodesFromClient property to enable client-side population of the nodes in the TreeView control. Notice that when client-side node population is enabled, nodes are populated dynamically on the client, without the need to post back to the server.
Note: