Share via

Microsoft.SharePoint.WebPartPages namespace

  • 05/27/2015

Provides classes, interfaces, and members for creating custom Web Parts and Web Part pages.

Classes

  Class Description
Public class AccessRequestsCSRBridge
Public class AccessRequestsHideOldRequestsLink
Public class AccessRequestsHideOldRequestsOnLoad
Public class AggregationWebPart This class and its members are reserved for internal use and are not intended to be used directly from your code.
Public class AllowFraming
Public class ArgumentClassWrapper Wraps System.Xml.Xsl.XsltArgumentList.
Public class AspTransformControl This class and its members are reserved for internal use and are not intended to be used directly from your code.
Public class AuthenticationButton Implements the authentication button control in Microsoft SharePoint Foundation.
Public class BadMarkupData This class and its members are reserved for internal use and are not intended to be used directly from your code.
Public class BaseXsltDataWebPart Represents the BaseXsltData Web Part.
Public class BaseXsltListWebPart An abstract base class that represents an XSLT-based list Web Part.
Public class BlogAdminWebPart Provides a control that displays administrative links for blogs. This class cannot be inherited.
Public class BlogLinksWebPart BlogLinksWebPart displays a static collection of liks (RSS, Alert Me) as a web part suitable for the hompage of a site, like a Blog site.
Public class BlogMonthQuickLaunch Represents a WebPart that is used to display the previous month’s links in the Quick Launch of a blog page.
Public class BlogYearArchive Represents a BlogMonthQuickLaunch Web Part control that is used to display the blog archive of the previous three years.
Public class BrowserBuilderType Used to specify use of the default builder for a custom property or provide a custom builder for the property at run time.
Public class BusinessDataProfileTemplate Page for Business Data Profile Template.
Public class ChartViewWebPart Reserved for internal use. This class and its members are not intended to be used directly from your code.
Public class ClientApplicationWebPartBase Provides a base class for classes that represent Web Parts that host external applications.
Public class ClientWebPart ClientWebPart
Public class ClientWebPartProperty Respresents a ClientWebPartProperty.
Public class ClientWebPartPropertyCollection ClientWebPartPropertyCollection Need ICollection for designer.
Public class ConsumerParameter Gets values from the ConsumerParameterCapabilities enumeration.
Public class ContentEditorWebPart Displays HTML and script-based content. The Web Part stores the content in a property or links to a source file.
Public class CustomPropertyToolPart Represents the default tool part that is displayed in the tool pane for a Web Part that implements one or more custom properties (properties other than those provided by the WebPart base class).
Public class DataFormConsumerConnectionPoint Represents the connection point that disables itself when the owning Web Part is not supposed to provide rows or to consume Web Part parameters.
Public class DataFormParameter Receives data (XML/XPathNavigable objects) from a Microsoft ASP.NET 2.0 DataSourceControl.
Public class DataFormProviderConnectionPoint Disables itself when the owning Web Part should not provide rows.
Public class DataFormWebPart An XSLT-rendering Web Part that receives its data (XML/XPathNavigable objects) from a DataSourceControl control.
Public class DataSourceControlDisabledException This class and its members are reserved for internal use and are not intended to be used directly from your code.
Public class DataViewWebPart Provides run-time support for data retrieval and presentation in Microsoft Office FrontPage 2003.
Public class DesignerBuilderType Contains references to builders for a design application compatible with Microsoft SharePoint Foundation, such as SharePoint Designer.
Public class EditorPartAdapter This class and its members are reserved for internal use and are not intended to be used directly from your code.
Public class FilterConsumerInfoBar Displays informative messages about Web Part connections to filter consumers.
Public class FilterInfoBar Displays contextual information in filters and filter consumers. Stores message information.
Public class FilterOperation Represents a filter operation in the list view that is serialized in view state across multiple HTTP requests.
Public class FilterProviderInfoBar Displays information about how the parent filter gets default values and to which Web Parts it is providing filter values.
Public class FriendlyNameAttribute Specifies the caption displayed in the property pane for a Web Part's custom property. If you don't specify this attribute, the actual property name will be displayed in the property pane.
Public class GettingStartedWebPart GettingStartedWebPart displays a static collection of Getting Started tiles
Public class GettingStartedWithAppCatalogSiteWebPart GettingStartedWithAppCatalogSiteWebPart displays a static collection of Getting Started tiles for app catalog site
Public class HtmlDesignerAttribute Defines the HtmlDesigner attribute that is used on a Web Part custom property. It specifies if a custom property uses a custom builder and the URL of the builder, or if the custom property does not use any builder, including any default builder.
Public class ImageWebPart Displays a linked image. It also supports Web Part Connections between compatible Web Parts.
Public class ImageWebPartMobileAdapter Changes the rendering of a ImageWebPart object so that it appears appropriately on a mobile device.
Public class ListFormWebPart Renders Microsoft SharePoint Foundation list forms in a Web Part.
Public class ListViewWebPart Renders SharePoint Foundation list views in a Web Part.
Public class ListViewWebPartMobileAdapter Changes the rendering of a ListViewWebPart object so that it appears appropriately on a mobile device.
Public class ManagedLinkAttribute Represents an attribute that is specified on properties containing URLs that should participate in link fixup.
Public class MembersWebPart Implements the list display on the Document Workspace home page.
Public class Menu Represents the menu for a Web Part.
Public class MenuItem Used to create and modify the behavior of items on a Web Part menu.
Public class MenuItemCollection Used to add, delete, and arrange the menu items that are displayed in a Web Part menu.
Public class MultilingualAttribute This attribute is specified on string or XmlNode properties that should participate in storing a value for each language.
Public class PageContentManager
Public class PageViewerWebPart Displays content from a linked Web Page, folder, or file. This Web Part renders its content within an IFRAME element.
Public class ParameterNameValueHashtable A collection of the name/value pairs and ad hoc filters that are used for parameters for the XSL/T value ParameterNameValueHashTable.
Public class PictureLibrarySlideshowWebPart Represents a PictureLibrarySlideshowWebPart that is used to display the pictures in a picture library slideshow.
Public class RequiresDesignerPermissionAttribute Sets the Web Part property attribute that determines whether designer permissions are required before a user can modify the property.
Public class ResourcesAttribute Derived from Object.Attribute and used for specifying how a property should be localized.
Public class ScriptEditorWebPart Web Part class that allows the display of HTML content placed there by designers only.
Public class SettingsLink Implements rendering for the Web Part Page menu (Modify Shared Page or Modify My Page).
Public class SilverlightToolPart Represents the editing Tool Part for the SilverlightWebPart.
Public class SilverlightWebPart Represents a Web Part that hosts a Silverlight application.
Public class SimpleFormWebPart Implements a Web Part that displays HTML forms.
Public class SPAttachedProperty This class and its members are reserved for internal use and are not intended to be used in your code.
Public class SPChrome Provides chrome capabilities for Web Parts.
Public class SPChromeSettings Provides chrome capabilities for Web Parts.
Public class SPConnectionParametersDictionary Provides a Specialized hybrid dictionary that contains the value of the data sent to the consumer Web Part when a SPRowToParametersTransformer is used to transform to connect Web Parts.
Public class SPConnectionValueInformation Provides information about the value of the data that is sent to the consumer WebPart using SPRowToParametersTransformer.
Public class SPEditorPartChrome Controls rendering of the EditorParts and ToolParts that are hosted in the Services ToolPane.
Public class SPLimitedWebPartCollection A read-only collection of the ASP.NET Web Parts exposed by SPLimitedWebPartManager.
Public class SPLimitedWebPartManager Provides a limited set of Web Part operations that can be performed in object model scenarios when there is no HttpContext and no instantiated Page object.
Public class SPProxyWebPartManager Provides a way for developers to declare static connections in a content page when a SPWebPartManager control is declared in the master page that is associated with the content page.
Public class SPRowToParametersTransformer Transforms data between a WebPart provider that implements the IWebPartRow interface and a consumer provider that implements the IWebPartParameters interface.
Public class SPTimelineWebPart This webpart displays static data as a timeline control. The rendering is done primarily on the browser side, and is done through positioning of divs and other elements in the browser.
Public class SPUserCodeProperty Represents a custom property for a Web Part in a sandboxed solution.
Public class SPUserCodePropertyCollection Represents a collection of SPUserCodeProperty objects.
Public class SPUserCodeWebPart Provides the container for a sandboxed solution Web Part.
Public class SPWebCategoryNameAttribute Defines the friendly or localized name of the category of a property in the CustomPropertyToolPart control inside the ToolPane.
Public class SPWebPartConnection Provides an object that enables two Web Parts to form a connection.
Public class SPWebPartConnectionCollection A collection of SPWebPartConnection objects.
Public class SPWebPartManager Manages all the Web Part controls, functionality, and events that occur on a webpage.
Public class SPWebPartsConnectionBuilder This class and its members are reserved for internal use and are not intended to be used directly from your code.
Public class SPWebPartTransformerCollection Represents a collection of WebPartTransformer objects.
Public class SupportsAttributeMarkupAttribute Enables an appropriate Web Part to be serialized into page markup using standard control attribute markup.
Public class TextZoomBuilder Obsolete. Contains the methods for the default design-time text builder.
Public class TileData This class is being used to store metadata for the tiles rendered by TilesViewWebPart.
Public class TilesViewWebPart TilesRenderingWebPart is the base WebPart class to be used to render a collection of tiles.
Public class TimelineConnectionProviderAttribute Attribute to mark a method as a provider for the timeline
Public class TimelineDataSourceToolPart This toolpart sets the data source data for the TimelineWebPart to send to the timeline control. It isn't a naming container or callback handler because it has no dynamicism in the toolpart itself.
Public class TitleBarWebPart Implements the title Web Part for a Web Part Page and renders the Microsoft.SharePoint.WebPartPages.SettingsLink.
Public class ToolPane Represents the tool pane on a Web Part Page. This class cannot be inherited.
Public class ToolPane.ErrorEventArgs Provides data for the ToolPane.ErrorOccurred event.
Public class ToolPane.ViewChangeEventArgs Provides data for the ViewChanging and ViewChanged events of the ToolPane class.
Public class ToolPart Defines custom tool parts that display a customized user interface for defining the properties of a Web Part inside of the tool pane.
Public class TransformableFilterValuesToFieldTransformer Allows the connection of standard filters that implement ITransformableFilterValuesto any Web Part that can consume IWebPartField. This transformer returns the first value of the first parameter sent via ITransformableFilterValues.
Public class TransformableFilterValuesToFilterValuesTransformer Applies standard filters that implement ITransformableFilterValues to any Web Part that can consume IFilterValues.
Public class TransformableFilterValuesToParametersTransformer Allows standard filters, which implement ITransformableFilterValues, to connect to any Web Part that can consume IWebPartParameters.
Public class UnknownXmlElementCollection Contains the XML elements that were not mapped to a property on the Web Part during import.
Public class UserDocsWebPart Displays documents authored by a particular user.
Public class UserTasksWebPart Displays the tasks assigned to a particular user.
Public class WebPart Provides the base class for creating Microsoft SharePoint Foundation Web Parts.
Public class WebPartAdder Represents a control that provides the user interface (UI) to allow users to add Web Parts to a page.
Public class WebPartAdder.SelectorCollection Represents and manages a collection of WebPartAdder.Selector objects.
Public class WebPartGalleryItem Provides the abstract class that represents a single item in the WebPartAdder.
Public class WebPartGalleryItemBase Provides an abstract class for the base implementation of the WebPartGalleryItem class.
Public class WebPartGallerySource Represents an abstract class that provides the method signatures to allow the WebPartGalleryItem objects to be added to the WebPartAdder.
Public class WebPartGallerySourceBase Provides an abstract base class for implementing Web Part gallery sources.
Public class WebPartGalleryXmlItemBase Represents a WebPart that is loaded from the Web Part XML.
Public class WebPartMobileAdapter Provides the common functionality needed by all adapters that make Web Parts on SharePoint pages accessible from mobile devices.
Public class WebPartMobileContentPanel Obsolete. Provides a container that holds mobile controls added by Web Part mobile adapters.
Public class WebPartMobileExpandCollapseScriptManager Obsolete. Provides rendering of the ECMAScript (JavaScript and JScript) that implements the visual expansion and collapse of a Web Part on a mobile page.
Public class WebPartMobilePage Obsolete. Represents a Web Part page that is designed for viewing on the small screens of mobile devices and that contains Web Parts that have mobile adapters.
Public class WebPartMobilePageNavigation Obsolete. Renders a link to navigate the user to either the Web Part mobile summary view page or the Web Part mobile detail page.
Public class WebPartMobilePageTitle Obsolete. Renders the title of a Web Part mobile page.
Public class WebPartMobileWebPage A mobile web page for contemporary view, which renders web parts using their mobile rendering adapters.
Public class WebPartMobileWebPagePanel A container class, which holds mobile webcontrols added via web part mobile rendering adapters.
Public class WebPartMobileWebPageTitle Renders the title of the web part mobile rendering page.
Public class WebPartPage Inherits from System.Web.UI.Page to implement a Web Part Page.
Public class WebPartPageUserException Extends the System.ApplicationException class. This class is used by the Web Part infrastructure and Web Part developers to throw and identify exceptions that will be rendered as error messages to users.
Public class WebPartPreview Provides a preview of a Web Part in the Web Part catalog.
Public class WebPartQuickAdd Obsolete. This class and its members are reserved for internal use and are not intended to be used directly from your code.
Public class WebPartStorageAttribute Specifies how a property should be stored.
Public class WebPartToolPart Represents a tool part that can be used to show and modify Web Part base class properties
Public class WebPartZone Allows you to create zones that are containers for Web Parts. The properties of this class allow you to specify how the zone will appear on your Web Parts page and also the behavior of the zone itself. For example, when you create the zone object, you can allow personalization and/or customization for the Web Parts placed within the zone.
Public class WikiContentWebpart Represents a WebPart that displays richly formatted content.
Public class WikiEditPage Represents the WebPartPage that enables the user to view and edit the wiki content.
Public class WikiPageEventArgs Provides data for the event that is raised by the WikiEditPage when the page is savings its contents.
Public class WSSXmlUrlResolver Creates a new resolver for the given webpart.
Public class XlvProviderConnectionPoint Defines the ProviderConnectionPoint for the XsltListViewWebPart.
Public class XmlWebPart Displays XML transformed on the server using XSL. The Web Part stores the content in a property or links to a source file.
Public class XsltListFormWebPart Uses Extensible Stylesheet Language Transformation (XSLT) to render data in a SharePoint list.
Public class XsltListViewWebPart Handles view rendering for default lists, such as document libraries and announcements.
Public class XsltListViewWebPartMobileAdapter Changes the rendering of a XsltListViewWebPart object so that it appears appropriately on a mobile device.

Structures

  Structure Description
Public structure PictureLibrarySlideshowWebPart.ImageInfo Defines information about an image that is being displayed in the PictureLibrarySlideshowWebPart.
Public structure WebPartAdder.Selector Determines whether a Web Part in the site gallery will be included in the list of Web-Parts that are displayed by the WebPartAdder control.

Interfaces

  Interface Description
Public interface IAddtoGallery Defines a property that allows a Web Part to add menu items to the Add Web Parts gallery tool pane.
Public interface IConnectionData Enables connections data between provider and consumer interfaces when the provider interface depends on the consumer interface to get data.
Public interface ICustomizeToolPane Provides methods and properties you must implement when creating a custom tool pane.
Public interface IDefaultFilterValue Consumed by WebParts that support default values via Part-to-Part connections. Provided by TransformableFilterValuesToDefaultValueTransformer.
Public interface IFilterValues Interface for parameters that describe the interaction between the data provider and the consumer of provider data.
Public interface IListWebPart Implement this interface to create the functionality that a Web Part class requires to be placed on a form. For example, the ListFormWebPart and ListViewWebPart classes both implement this interface so that they can be positioned in different zones on a form.
Public interface IRelatedFormWebPart Provides an interface that a Web Part can implement to enable connections to related Web Parts on a forms page.
Public interface IRuntimeFilter Obsolete. Controls which Web Parts are rendered at run time based on a set of arbitrary parameters stored in the IsIncludedFilter property of the Web Part base class.
Public interface IRuntimeFilter2 Controls which Web Parts are rendered at run time based on a set of arbitrary parameters that are stored in the AuthorizationFilter property of the Web Part base class.
Public interface ISampleData Required if a Web Part wants to display sample data for data source controls.
Public interface ISPHierarchyData Provides an interface to create hierarchical XmlDocument objects from data sources that derive from the IHierarchicalDataSource class.
Public interface IToolPaneControl Represents an advanced WebPartToolPart Web control.
Public interface ITransformableFilterValues The interface supported by filter providers.

Delegates

  Delegate Description
Public delegate ToolPane.ErrorOccurredEventHandler Represents the method that handles the ErrorOccurred event of the ToolPane class.
Public delegate ToolPane.ViewChangeEventHandler Acts as an event handler delegate when the view of the ToolPane object changes.

Enumerations

  Enumeration Description
Public enumeration CacheDataStorage Represents the type of caching to use when storing data for a data view.
Public enumeration CacheType Defines the location of cache storage for caching Web Part values.
Public enumeration ConsumerParameterCapabilities Used by a consumer Web part to indicate supported filter parameter capabilities.
Public enumeration CSRRenderMode
Public enumeration Direction Obsolete. Specifies the language direction for the Dir property of a Web Part.
Public enumeration FrameState Obsolete. Specifies the value of the FrameState property.
Public enumeration FrameType Obsolete. Specifies the value of the FrameType property.
Public enumeration HorizontalAlignment Determines the value of the HorizontalAlignment property of the ImageWebPart class.
Public enumeration MembersWebPartDisplayType Displays members of a WebPartZone in a document workspace home page. Membership is displayed as a list, by using the SPList class.
Public enumeration Orientation Obsolete. Specifies the orientation of Web Parts in a WebPartZone control.
Public enumeration PathPattern Specifies the kind of path that will be used for the link value specified in the ContentLink property of the ContentEditorWebPart class, the ContentLink property of the PageViewerWebPart class, the ImageLink property of ImageWebPart class, and the XslLink and XmlLink properties of the XmlWebPart class.
Public enumeration Permissions Specifies the value of the Permissions property of the Microsoft.SharePoint.WebPartPages.WebPart class.
Public enumeration SPPictureLibrarySlideshowDisplayStyle Enumerates the layouts of the picture title and description that are displayed in the PictureLibrarySlideshowWebPart.
Public enumeration SPPictureLibrarySlideshowMode Enumerates the order in which the pictures are displayed in the PictureLibrarySlideshowWebPart.
Public enumeration Storage Specifies the value for the WebPartStorageAttribute class.
Public enumeration TileLaunchBehavior Enumeration of possible behaviors of a tile when clicked.
Public enumeration TilesBaseViewID
Public enumeration ToolPane.ToolPaneView Defines the settings of the View property of the ToolPane class.
Public enumeration VerticalAlignment Determines the value of the VerticalAlignment property of the ImageWebPart class.
Public enumeration ViewType Defines the settings for the ViewType property of the ListViewWebPart class.
Protected enumeration WebPartMobileAdapter.WebPartIconLink Specifies whether an icon in a Web Part on a mobile page will function as a clickable link and, if so, whether it will link to the detailed view of the Web Part or the summary view.
Public enumeration WebPartToolPart.Categories Represents the categories of base properties that are available for an instance of the WebPartToolPart tool part.
Public enumeration WebPartToolPart.Properties Represents the base properties of the WebPart class.