SiteMapDataSourceView Class

Definition

Provides a strongly typed HierarchicalDataSourceView object for the SiteMapDataSource control.

public ref class SiteMapDataSourceView : System::Web::UI::DataSourceView
public class SiteMapDataSourceView : System.Web.UI.DataSourceView
type SiteMapDataSourceView = class
    inherit DataSourceView
Public Class SiteMapDataSourceView
Inherits DataSourceView
Inheritance
SiteMapDataSourceView

Remarks

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.

Constructors

SiteMapDataSourceView(SiteMapDataSource, String, SiteMapNode)

Initializes a new named instance of the SiteMapDataSourceView class, adding the single specified node to the internal collection of nodes.

SiteMapDataSourceView(SiteMapDataSource, String, SiteMapNodeCollection)

Initializes a new named instance of the SiteMapDataSourceView class, setting the internal collection of nodes to the specified node collection.

Properties

CanDelete

Gets a value indicating whether the DataSourceView object associated with the current DataSourceControl object supports the ExecuteDelete(IDictionary, IDictionary) operation.

(Inherited from DataSourceView)
CanInsert

Gets a value indicating whether the DataSourceView object associated with the current DataSourceControl object supports the ExecuteInsert(IDictionary) operation.

(Inherited from DataSourceView)
CanPage

Gets a value indicating whether the DataSourceView object associated with the current DataSourceControl object supports paging through the data retrieved by the ExecuteSelect(DataSourceSelectArguments) method.

(Inherited from DataSourceView)
CanRetrieveTotalRowCount

Gets 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)
CanSort

Gets 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)
CanUpdate

Gets a value indicating whether the DataSourceView object associated with the current DataSourceControl object supports the ExecuteUpdate(IDictionary, IDictionary, IDictionary) operation.

(Inherited from DataSourceView)
Events

Gets a list of event-handler delegates for the data source view.

(Inherited from DataSourceView)
Name

Gets the name of the data source view.

(Inherited from DataSourceView)

Methods

CanExecute(String)

Determines whether the specified command can be executed.

(Inherited from DataSourceView)
Delete(IDictionary, IDictionary, DataSourceViewOperationCallback)

Performs an asynchronous delete operation on the list of data that the DataSourceView object represents.

(Inherited from DataSourceView)
Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
ExecuteCommand(String, IDictionary, IDictionary)

Executes the specified command.

(Inherited from DataSourceView)
ExecuteCommand(String, IDictionary, IDictionary, DataSourceViewOperationCallback)

Executes the specified command.

(Inherited from DataSourceView)
ExecuteDelete(IDictionary, IDictionary)

Performs a delete operation on the list of data that the DataSourceView object represents.

(Inherited from DataSourceView)
ExecuteInsert(IDictionary)

Performs an insert operation on the list of data that the DataSourceView object represents.

(Inherited from DataSourceView)
ExecuteSelect(DataSourceSelectArguments)

Gets the collection of the SiteMapNode objects that represents the site navigation structure for the current user.

ExecuteUpdate(IDictionary, IDictionary, IDictionary)

Performs an update operation on the list of data that the DataSourceView object represents.

(Inherited from DataSourceView)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
Insert(IDictionary, DataSourceViewOperationCallback)

Performs an asynchronous insert operation on the list of data that the DataSourceView object represents.

(Inherited from DataSourceView)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
OnDataSourceViewChanged(EventArgs)

Raises the DataSourceViewChanged event.

RaiseUnsupportedCapabilityError(DataSourceCapabilities)

Called by the RaiseUnsupportedCapabilitiesError(DataSourceView) method to compare the capabilities requested for an ExecuteSelect(DataSourceSelectArguments) operation against those that the view supports.

(Inherited from DataSourceView)
Select(DataSourceSelectArguments)

Gets the collection of the SiteMapNode objects that represents the site navigation structure for the current user.

Select(DataSourceSelectArguments, DataSourceViewSelectCallback)

Gets a list of data asynchronously from the underlying data storage.

(Inherited from DataSourceView)
ToString()

Returns a string that represents the current object.

(Inherited from Object)
Update(IDictionary, IDictionary, IDictionary, DataSourceViewOperationCallback)

Performs an asynchronous update operation on the list of data that the DataSourceView object represents.

(Inherited from DataSourceView)

Events

DataSourceViewChanged

Occurs when the data source view has changed.

(Inherited from DataSourceView)

Applies to

See also