This documentation is archived and is not being maintained.

SiteMapHierarchicalDataSourceView Class

Represents a data view on a site map node or collection of nodes for a SiteMapDataSource control.


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

public class SiteMapHierarchicalDataSourceView : HierarchicalDataSourceView

The SiteMapHierarchicalDataSourceView type exposes the following members.

Public methodSiteMapHierarchicalDataSourceView(SiteMapNode)Initializes a new instance of the SiteMapHierarchicalDataSourceView class, adding the specified node to the IHierarchicalEnumerable collection that the data source view maintains.
Public methodSiteMapHierarchicalDataSourceView(SiteMapNodeCollection)Initializes a new instance of the SiteMapHierarchicalDataSourceView class, setting the specified collection to the IHierarchicalEnumerable collection that the data source view maintains.

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSelectGets the collection of the SiteMapNode objects that represents the site navigation structure for the current user. (Overrides HierarchicalDataSourceView.Select().)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

The SiteMapDataSource control can present its underlying data in both tabular and hierarchical format to Web server controls that bind to it. The SiteMapHierarchicalDataSourceView is used by controls developers, but not page developers or in page code.

Controls such as Menu or DropDownList use the SiteMapDataSource to bind to site map data and present it in list form, while controls that derive from the HierarchicalDataBoundControl class, such as TreeView, bind to sitemap data and present it in hierarchical form.

If a data-bound control calls the GetView method of the SiteMapDataSource, a SiteMapDataSourceView is created by the data source. If a control calls the HierarchicalDataBoundControl GetHierarchicalView method, a SiteMapHierarchicalDataSourceView is created. The SiteMapDataSourceView class is provided for Web server controls that derive from DataBoundControl and bind to lists and tabular data, while the SiteMapHierarchicalDataSourceView is provided for Web server controls that derive from HierarchicalDataBoundControl and bind to hierarchical data.

Like all HierarchicalDataSourceView helper objects, the SiteMapHierarchicalDataSourceView defines the operations that the data source can perform with the underlying data. Because the SiteMapHierarchicalDataSourceView class only overrides the Select method, the associated SiteMapDataSource control does not support sort expressions or insert, delete, or update operations.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.