System.Web.UI.WebControls.TreeView.PopulateNodesFromClient Property

Gets or sets a value indicating whether node data is populated on demand from the client.

Syntax

[System.ComponentModel.DefaultValue(true)]
public bool PopulateNodesFromClient { set; get; }

Value

Documentation for this section has not yet been entered.

Remarks

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 System.Web.UI.WebControls.TreeView control supports dynamic node population. When the TreeNode.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 TreeView.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 System.Web.UI.WebControls.TreeView control posts back to the server to populate the nodes.

Note:

The TreeView.EnableClientScript property must also be set to true in order for the TreeView.PopulateNodesFromClient property to be set to true.

To populate a node on the client, first set the TreeView.PopulateNodesFromClient property to true and then set the TreeNode.PopulateOnDemand property for the node to true. Next, define an event-handling method for the TreeView.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 TreeNode.ChildNodes collection of the node being populated. You create a node structure by adding System.Web.UI.WebControls.TreeNode objects to the TreeNode.ChildNodes collection of a parent node.

Note:

When the TreeNode.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 in browsers that support callback scripts. To check whether a browser supports callback scripts access, use the System.Web.Configuration.HttpCapabilitiesBase.SupportsCallback property of the System.Web.HttpBrowserCapabilities class. You can access the instance of the System.Web.HttpBrowserCapabilities class for the current request through the System.Web.HttpRequest.Browser property of the System.Web.HttpRequest class.

The value of this property is stored in view state.

Requirements

Namespace: System.Web.UI.WebControls
Assembly: System.Web (in System.Web.dll)
Assembly Versions: 2.0.0.0
Since: .NET 2.0