IHierarchicalDataSource.GetHierarchicalView Method (String)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets the view helper object for the IHierarchicalDataSource interface for the specified path.

Namespace:   System.Web.UI
Assembly:  System.Web (in System.Web.dll)

HierarchicalDataSourceView GetHierarchicalView(
	string viewPath


Type: System.String

The hierarchical path of the view to retrieve.

Return Value

Type: System.Web.UI.HierarchicalDataSourceView

Returns a HierarchicalDataSourceView that represents a single view of the data at the hierarchical level identified by the viewPath parameter.

The IHierarchicalDataSource interface, like the IDataSource interface, defines a method that hierarchical data source controls use to retrieve a data source view. Like all DataSourceView helper objects that are associated with data source controls, a HierarchicalDataSourceView object defines the operations that the data source can perform with the underlying data. However, although data source controls that represent tabular data typically have only one named view, hierarchical data source controls support a view for each level of hierarchical data that the data source control represents. The level of hierarchical data is identified by a unique hierarchical path, passed as the viewPath parameter.

The following code example demonstrates how to override the GetHierarchicalView method in a class that extends the HierarchicalDataSourceControl class to retrieve a strongly typed HierarchicalDataSourceView object for a unique hierarchical path. The FileSystemDataSource class's implementation of GetHierarchicalView retrieves a FileSystemDataSourceView object for a specified file system path. This code example is part of a larger example provided for the HierarchicalDataSourceControl class.

using System;
using System.Collections;
using System.IO;
using System.Runtime.InteropServices;
using System.Security.Permissions;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;

public class FileSystemDataSource :
    HierarchicalDataSourceControl, IHierarchicalDataSource
    private FileSystemDataSourceView view = null;

    public FileSystemDataSource() : base() { }

    protected override HierarchicalDataSourceView
        GetHierarchicalView(string viewPath)
        view = new FileSystemDataSourceView(viewPath);
        return view;

.NET Framework
Available since 2.0
Return to top