This documentation is archived and is not being maintained.

HierarchicalDataBoundControl.GetData Method

Retrieves a HierarchicalDataSourceView object that the data-bound control uses to perform data operations.

Namespace: System.Web.UI.WebControls
Assembly: System.Web (in system.web.dll)

protected virtual HierarchicalDataSourceView GetData (
	string viewPath
protected HierarchicalDataSourceView GetData (
	String viewPath
protected function GetData (
	viewPath : String
) : HierarchicalDataSourceView
Not applicable.



The hierarchical path of the view to retrieve.

Return Value

The HierarchicalDataSourceView object that the data-bound control uses to perform data operations.

Exception typeCondition


A HierarchicalDataSourceView could not be retrieved for the specified viewPath.

The GetData method retrieves a HierarchicalDataSourceView object from the associated data source control by calling the GetDataSource method.

The following code example demonstrates how the GetData method is called to retrieve the HierarchicalDataSourceView object from the associated data source control and how the HierarchicalDataSourceView.Select method is called to retrieve the data. This code example is part of a larger example provided for the HierarchicalDataBoundControl class.

protected override void PerformDataBinding() {

    // Do not attempt to bind data if there is no
    // data source set.
    if (!IsBoundUsingDataSourceID && (DataSource == null)) {
    HierarchicalDataSourceView view = GetData(RootNode.DataPath);
    if (view == null) {
        throw new InvalidOperationException
            ("No view returned by data source control.");
    IHierarchicalEnumerable enumerable = view.Select();
    if (enumerable != null) {
        try {
            RecurseDataBindInternal(RootNode, enumerable, 1);
        finally {
private void RecurseDataBindInternal(TreeNode node, 
    IHierarchicalEnumerable enumerable, int depth) {                                    
    foreach(object item in enumerable) {
        IHierarchyData data = enumerable.GetHierarchyData(item);

        if (null != data) {
            // Create an object that represents the bound data
            // to the control.
            TreeNode newNode = new TreeNode();
            RootViewNode rvnode = new RootViewNode();
            rvnode.Node = newNode;
            rvnode.Depth = depth;

            // The dataItem is not just a string, but potentially
            // an XML node or some other container. 
            // If DataTextField is set, use it to determine which 
            // field to render. Otherwise, use the first field.                    
            if (DataTextField.Length > 0) {
                newNode.Text = DataBinder.GetPropertyValue
                    (data, DataTextField, null);
            else {
                PropertyDescriptorCollection props = 

                // Set the "default" value of the node.
                newNode.Text = String.Empty;                        

                // Set the true data-bound value of the TextBox,
                // if possible.
                if (props.Count >= 1) {                        
                    if (null != props[0].GetValue(data)) {
                        newNode.Text = 

            if (data.HasChildren) {
                IHierarchicalEnumerable newEnumerable = 
                if (newEnumerable != null) {                            
                        newEnumerable, depth+1 );
            if ( _maxDepth < depth) _maxDepth = depth;

Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0