Microsoft.SharePoint.Portal.WebControls Namespace

  • Article

The Microsoft.SharePoint.Portal.WebControls namespace contains Web Parts for Microsoft SharePoint Portal Server.

Some classes or members of the Microsoft.SharePoint.Portal.WebControls namespace are not supported. It is recommended that you refrain from using unsupported classes or members when developing solutions for Microsoft SharePoint Products and Technologies.

Classes

The following table lists the classes of the Microsoft.SharePoint.Portal.WebControls namespace and shows a brief description of each.

Class Description
AudiencePicker Enables a user to pick one or more audiences graphically.
BaseAreaWebPart Creates Web Parts that act like portals.
BaseAreaWebPart.AreaReturnData Returns array lists for the Render method.
BreadCrumbTrail Represents the location of the user on the site page.
CacheableWebPart Assists the derived Web Part with HTML output caching.
CategoryNavigationWebPart Represents the vertical and horizontal navigation bar.
CategoryPicker Chooses areas for display.
DataResultBase Defines all the general rendering properties and methods for data results. The DataResultBase class is the base class for the QueryResultBase class, which is the base class for the SearchResults Web Part in the search results page.
EditModeSettingsLink Defines the edit mode settings link in the upper right corner of the page.
HtmlMenu Represents a template that defines a menu.
HtmlMenuButton The Web Form control that instantiates an instance of a menu template.
HtmlMenuItem Represents a template that defines an item that is contained in a menu.
HtmlMenuItemCollection Represents a template that defines the menu items for a specific menu.
ListingSummary Provides summary information for listings.
PageLevelError Defines the error for the page.
ResultsManagementControls Implements the results management Web Part that is used to perform operations on one or more sets of search results.

Visit QueryResultBase

 Represents the base class for all search results Web Parts.

Visit SearchBox

 Implements the search box Web Part in the SharePoint Portal Server search page.

Visit SearchResults

 Implements the search results Web Part in the SharePoint Portal Server search page.
TextEditor Defines the text editor for the user.
TOCPart Displays area content.

Enumerations

The following table lists the enumerations of the Microsoft.SharePoint.Portal.WebControls namespace and shows a brief description of each.

Enumeration Description
CategoryNavigationWebPartOrientation Indicates whether the layout is horizontal or vertical.
CategoryNavigationWebPartRenderStyle Indicates the number of layers and whether the layout is horizontal or vertical.
ListingSummaryBestBetVisibility Specifies the type of visibility of the Best Bets.
ListingSummaryDisplayTemplate Specifies the type of visibility of the listings.
ListingSummaryGroupBy Specifies the type grouping of the listings to be displayed.
ListingSummarySortDirection Specifies the direction for sorting the listings.
ListingSummarySortOrder Specifies the order for sorting the listings.
PageLevelErrorImage Specifies the image that is displayed for an error or a warning.

Structures

The following table lists the structures of the Microsoft.SharePoint.Portal.WebControls namespace and shows a brief description of each.

Name Description
AreaDataFirstLayer Contains information about the first layer of data for an area.
AreaDataSecondLayer Contains information about the second layer information for a given query.
AreaListingDataFirstLayer Contains the listings under the current area.
AreaListingDataSecondLayer Contains information about the grandchildren listings of the current area.