TableOfContentsWebPart class

Article
05/27/2015

Renders a hierarchical view of Web Parts and Web pages when structural navigation is enabled, and renders the navigation term set when managed navigation is enabled.

This API is not CLS-compliant.

Inheritance hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      System.Web.UI.WebControls.Panel
        System.Web.UI.WebControls.WebParts.Part
          System.Web.UI.WebControls.WebParts.WebPart
            Microsoft.SharePoint.WebPartPages.WebPart
              Microsoft.SharePoint.WebPartPages.BaseXsltDataWebPart
                Microsoft.SharePoint.WebPartPages.DataFormWebPart
                  Microsoft.SharePoint.Publishing.WebControls.CmsDataFormWebPart
                    Microsoft.SharePoint.Publishing.WebControls.LevelHierarchyWebPart
                      Microsoft.SharePoint.Publishing.WebControls.TableOfContentsWebPart

Namespace: Microsoft.SharePoint.Publishing.WebControls
Assembly: Microsoft.SharePoint.Publishing (in Microsoft.SharePoint.Publishing.dll)

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
<AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
<SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel := True)> _
<AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
<SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel := True)> _
Public Class TableOfContentsWebPart _
    Inherits LevelHierarchyWebPart _
    Implements IWebPartVariationUpdate
'Usage
Dim instance As TableOfContentsWebPart

[CLSCompliantAttribute(false)]
[AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal)]
[SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel = true)]
[AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level = AspNetHostingPermissionLevel.Minimal)]
[SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel = true)]
public class TableOfContentsWebPart : LevelHierarchyWebPart, 
    IWebPartVariationUpdate

Remarks

This class derives from the LevelHierarchyWebPart class and uses level styling in XSL templates to render a Web page and its child pages. It is associated with the TableOfContentsDataSource class that provides the data for this Web Part. This class always displays Web sites, and can be configured either to display or not display Web pages. A manual sort can be applied to each Web Part or they can be sorted in navigation.

Thread safety

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

Share via

TableOfContentsWebPart class

Inheritance hierarchy

Syntax

Remarks

Thread safety

See also

Reference

Inheritance hierarchy

Additional resources