BaseTableOfContentsDataSource Class

Definition

Important

This API is not CLS-compliant.

Provides the base class for all table of contents data sources.

public ref class BaseTableOfContentsDataSource abstract : Microsoft::SharePoint::Publishing::WebControls::LevelHierarchyDataSource
[System.CLSCompliant(false)]
public abstract class BaseTableOfContentsDataSource : Microsoft.SharePoint.Publishing.WebControls.LevelHierarchyDataSource
type BaseTableOfContentsDataSource = class
    inherit LevelHierarchyDataSource
Public MustInherit Class BaseTableOfContentsDataSource
Inherits LevelHierarchyDataSource
Inheritance
Derived
Attributes

Constructors

BaseTableOfContentsDataSource(SiteMapProvider)

Initializes a new instance of a BaseTableOfContentsDataSource object by using the specified SiteMapProvider object.

Properties

AnchorWeb

Gets or sets the URL from which to start gathering data.

HeaderTemplate

Gets or sets the style used to display the header text.

(Inherited from LevelHierarchyDataSource)
HeaderText

Gets or sets the text to display as a header above the contents of the data.

(Inherited from LevelHierarchyDataSource)
IncludeContentFromStartingLocation

Gets or sets a value that indicates whether to include the starting site map node as the root site map node in the site map view.

Level1StyleTemplate

Gets or sets the style used to display items in the first-level data.

(Inherited from LevelHierarchyDataSource)
Level2StyleTemplate

Gets or sets the style used to display items in the second-level data style template.

(Inherited from LevelHierarchyDataSource)
Level3StyleTemplate

Gets or sets the style used to display items in the third-level data.

(Inherited from LevelHierarchyDataSource)
NumColumns

Gets or sets the number of columns used to render levels.

(Inherited from LevelHierarchyDataSource)
NumLevels

Gets or sets the number of levels to get data for.

(Inherited from LevelHierarchyDataSource)
Provider

Gets the current instance of the SiteMapProvider object.

TocView

Gets the associated BaseTableOfContentsDataSourceView object.

Methods

GetHierarchicalView(String)

When overridden in derived classes, gets the view helper object for the IHierarchicalDataSource interface for the specified path.

(Inherited from LevelHierarchyDataSource)
GetView(String)

Null implementation of the GetView method required to implement the IDataSource interface.

(Inherited from LevelHierarchyDataSource)
GetViewNames()

Null implementation of the GetView method required to implement IDataSource interface.

(Inherited from LevelHierarchyDataSource)
IDataSourceOnDataSourceChanged(EventArgs)

Raises an event handler.

(Inherited from LevelHierarchyDataSource)

Events

DataSourceChanged

Adds or removes an event handler when the data source changes.

(Inherited from LevelHierarchyDataSource)

Applies to