SiteMapDataSourceView Class

Provides a strongly typed HierarchicalDataSourceView object for the SiteMapDataSource control.

System.Object
  System.Web.UI.DataSourceView
    System.Web.UI.WebControls.SiteMapDataSourceView

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

public class SiteMapDataSourceView : DataSourceView

The SiteMapDataSourceView type exposes the following members.

  NameDescription
Public methodSiteMapDataSourceView(SiteMapDataSource, String, SiteMapNode)Initializes a new named instance of the SiteMapDataSourceView class, adding the single specified node to the internal collection of nodes.
Public methodSiteMapDataSourceView(SiteMapDataSource, String, SiteMapNodeCollection)Initializes a new named instance of the SiteMapDataSourceView class, setting the internal collection of nodes to the specified node collection.
Top

  NameDescription
Public propertyCanDeleteGets a value indicating whether the DataSourceView object associated with the current DataSourceControl object supports the ExecuteDelete operation. (Inherited from DataSourceView.)
Public propertyCanInsertGets a value indicating whether the DataSourceView object associated with the current DataSourceControl object supports the ExecuteInsert operation. (Inherited from DataSourceView.)
Public propertyCanPageGets a value indicating whether the DataSourceView object associated with the current DataSourceControl object supports paging through the data retrieved by the ExecuteSelect method. (Inherited from DataSourceView.)
Public propertyCanRetrieveTotalRowCountGets a value indicating whether the DataSourceView object associated with the current DataSourceControl object supports retrieving the total number of data rows, instead of the data. (Inherited from DataSourceView.)
Public propertyCanSortGets a value indicating whether the DataSourceView object associated with the current DataSourceControl object supports a sorted view on the underlying data source. (Inherited from DataSourceView.)
Public propertyCanUpdateGets a value indicating whether the DataSourceView object associated with the current DataSourceControl object supports the ExecuteUpdate operation. (Inherited from DataSourceView.)
Protected propertyEventsGets a list of event-handler delegates for the data source view. (Inherited from DataSourceView.)
Public propertyNameGets the name of the data source view. (Inherited from DataSourceView.)
Top

  NameDescription
Public methodCanExecuteDetermines whether the specified command can be executed. (Inherited from DataSourceView.)
Public methodDeletePerforms an asynchronous delete operation on the list of data that the DataSourceView object represents. (Inherited from DataSourceView.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodExecuteCommand(String, IDictionary, IDictionary)Executes the specified command. (Inherited from DataSourceView.)
Public methodExecuteCommand(String, IDictionary, IDictionary, DataSourceViewOperationCallback)Executes the specified command. (Inherited from DataSourceView.)
Protected methodExecuteDeletePerforms a delete operation on the list of data that the DataSourceView object represents. (Inherited from DataSourceView.)
Protected methodExecuteInsertPerforms an insert operation on the list of data that the DataSourceView object represents. (Inherited from DataSourceView.)
Protected methodExecuteSelectGets the collection of the SiteMapNode objects that represents the site navigation structure for the current user. (Overrides DataSourceView.ExecuteSelect(DataSourceSelectArguments).)
Protected methodExecuteUpdatePerforms an update operation on the list of data that the DataSourceView object represents. (Inherited from DataSourceView.)
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 the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInsertPerforms an asynchronous insert operation on the list of data that the DataSourceView object represents. (Inherited from DataSourceView.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnDataSourceViewChangedRaises the DataSourceViewChanged event. (Overrides DataSourceView.OnDataSourceViewChanged(EventArgs).)
Protected methodRaiseUnsupportedCapabilityErrorCalled by the RaiseUnsupportedCapabilitiesError method to compare the capabilities requested for an ExecuteSelect operation against those that the view supports. (Inherited from DataSourceView.)
Public methodSelect(DataSourceSelectArguments)Gets the collection of the SiteMapNode objects that represents the site navigation structure for the current user.
Public methodSelect(DataSourceSelectArguments, DataSourceViewSelectCallback)Gets a list of data asynchronously from the underlying data storage. (Inherited from DataSourceView.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodUpdatePerforms an asynchronous update operation on the list of data that the DataSourceView object represents. (Inherited from DataSourceView.)
Top

  NameDescription
Public eventDataSourceViewChangedOccurs when the data source view has changed. (Inherited from DataSourceView.)
Top

The SiteMapDataSource control enables ASP.NET data-bound controls, such as the TreeView and Menu controls, to bind to site map data. The SiteMapDataSourceView class is used by controls developers but it is not used by page developers nor in page code.

The SiteMapDataSource returns a SiteMapDataSourceView for a specified hierarchical path when the Select method is called. Like all hierarchical data source view objects, the SiteMapDataSourceView is not named; rather, its is identified by its unique hierarchical path.

The SiteMapDataSourceView is a wrapper class on a SiteMapNodeCollection collection. The SiteMapNodeCollection class implements the IHierarchicalEnumerable interface, which the SiteMapDataSourceView class returns from a call to Select method. Because the SiteMapDataSource and SiteMapDataSourceView work with SiteMapNode objects, the view maintains an internal SiteMapNodeCollection to contain them. The collection is initialized using the view's constructors and accessed with the Select method.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft