System.Web.UI.WebControls.WebParts Namespace

Contains classes and interfaces known collectively as the Web Parts control set. You can use these classes to create Web pages whose appearance and behavior can be modified (personalized) by end users. Each user's personalized settings for a page are saved for future browser sessions.

Classes

AppearanceEditorPart

Provides an editor control that enables end users to edit several user interface (UI) properties on an associated WebPart control. This class cannot be inherited.

BehaviorEditorPart

Provides an editor control that enables end users to edit several user interface (UI) properties on an associated WebPart control. This class cannot be inherited.

CatalogPart

Serves as the base class for controls that reside in CatalogZoneBase zones, and that provide catalogs of available Web server controls (especially WebPart controls) that users can add to a Web page.

CatalogPartChrome

Enables developers to override the rendering for only the selected sections of CatalogPart controls in a CatalogZoneBase zone.

CatalogPartCollection

Contains a collection of CatalogPart controls used to provide catalogs of Web server controls that end users can add to a Web page. This class cannot be inherited.

CatalogZone

Serves as the primary control in the Web Parts control set for hosting CatalogPart controls on a Web page.

CatalogZoneBase

Serves as the base class for all zone controls that act as catalogs. Catalogs contain lists of WebPart controls that users can add to a Web page.

ConnectionConsumerAttribute

Identifies the callback method in a server control acting as the consumer in a Web Parts connection, and enables developers to specify details about the consumer's connection point.

ConnectionInterfaceCollection

Represents a collection of interfaces for use in Web Parts connections.

ConnectionPoint

Serves as the base class for defining connection point objects that enable the consumer control and the provider control in a Web Parts connection to share data.

ConnectionProviderAttribute

Identifies the callback method in a server control acting as the provider in a Web Parts connection, and enables developers to specify details about the provider's connection point.

ConnectionsZone

Provides a user interface (UI) that enables users to form connections between WebPart and other server controls that reside in WebPartZoneBase zones.

ConsumerConnectionPoint

Defines a connection point object that enables a server control acting as a consumer to form a connection with a provider.

ConsumerConnectionPointCollection

Represents a collection of connection points for a control in a Web Parts zone acting as a consumer. This class cannot be inherited.

DeclarativeCatalogPart

Enables developers to add a catalog of WebPart or other server controls to a Web page in the declarative, page persistence format. This class cannot be inherited.

EditorPart

Serves as the base class for controls that reside in EditorZoneBase zones and are used to edit WebPart controls.

EditorPartChrome

Enables developers to override the rendering for only the selected sections of EditorPart controls in an EditorZoneBase zone.

EditorPartCollection

Contains a collection of EditorPart controls used for editing the properties, layout, appearance, and behavior of WebPart controls. This class cannot be inherited.

EditorZone

Serves as the primary control in the Web Parts control set for hosting EditorPart controls on a Web page.

EditorZoneBase

Serves as the base class for all zone controls that act as containers for EditorPart controls.

ErrorWebPart

Inserted into a Web page as a placeholder when the attempt to load or create a new instance of a dynamic WebPart control has failed.

GenericWebPart

Wraps server controls that are not WebPart controls so that they can appear and behave as true WebPart controls at run time.

ImportCatalogPart

Imports a description file for a WebPart control (or other ASP.NET server control used as a WebPart control), so that users can add the control to a Web page with pre-defined settings. This class cannot be inherited.

LayoutEditorPart

Provides an editor control that enables end users to edit several layout-oriented user interface (UI) properties on an associated WebPart control. This class cannot be inherited.

PageCatalogPart

Provides a catalog that keeps references to all WebPart controls (and other server controls contained in WebPartZoneBase zones) that a user has closed on a single Web Parts page, which enables users to add the closed controls back to the page. This class cannot be inherited.

Part

Serves as the base class for all Web Parts part controls, which render a modular user interface on a Web Forms page.

PersonalizableAttribute

Represents the personalization attribute. This class cannot be inherited.

PersonalizationAdministration

Implements management and administrative functionality for Web Parts personalization. This class cannot be inherited.

PersonalizationDictionary

Encapsulates basic validation rules that indicate whether a piece of custom data is considered personalizable in either User or Shared scope.

PersonalizationEntry

Represents core pieces of custom personalization state information contained in a PersonalizationDictionary object. This class cannot be inherited.

PersonalizationProvider

Implements the basic functionality for a personalization provider.

PersonalizationProviderCollection

Stores references to PersonalizationProvider objects indexed by name. This class cannot be inherited.

PersonalizationState

Defines the basic functionality that represents the personalization data for a page.

PersonalizationStateInfo

When overridden in a derived class, implements a representation of information about a set of Web Parts data for a page.

PersonalizationStateInfoCollection

Provides a collection of SharedPersonalizationStateInfo and UserPersonalizationStateInfo objects.

PersonalizationStateQuery

Represents a set of query parameters that can be passed to a personalization provider using the various get and find methods. This class cannot be inherited.

PropertyGridEditorPart

Provides an editor control that enables end users to edit custom properties on an associated WebPart or server control. This class cannot be inherited.

ProviderConnectionPoint

Defines a connection point object that enables a server control acting as a provider to form a connection with a consumer.

ProviderConnectionPointCollection

Contains a collection of all ProviderConnectionPoint objects associated with a particular WebPart or server control acting as a provider in a connection. This class cannot be inherited.

ProxyWebPart

Represents the base class for Web Parts controls that under certain conditions must replace other Web Parts controls on a page.

ProxyWebPartConnectionCollection

Contains a collection of static WebPartConnection objects, which is used when the connections are declared in content pages and the WebPartManager control is declared in a master page. This class cannot be inherited.

ProxyWebPartManager

Provides a way for developers to declare static connections in a content page when a WebPartManager control has been declared in the content page's associated master page.

RowToFieldTransformer

Transforms data in a Web Parts connection from a provider that implements the IWebPartRow interface to a consumer expecting data through the IWebPartField interface.

RowToParametersTransformer

Transforms data in a Web Parts connection from a provider that implements the IWebPartRow interface to a consumer expecting to receive data from a provider that implements the IWebPartParameters interface.

SharedPersonalizationStateInfo

Represents a lightweight version of shared personalization information about a page. This class cannot be inherited.

SqlPersonalizationProvider

Implements a personalization provider that uses Microsoft SQL Server.

TitleStyle

Specifies the style characteristics for the title bars of Web Parts controls within a zone.

ToolZone

Serves as the base class for a set of helper zones that appear only in certain associated page display modes.

TransformerTypeCollection

Provides a read-only collection of WebPartTransformer objects.

UnauthorizedWebPart

Used to create a placeholder object whenever the WebPartManager control's IsAuthorized method returns false for a WebPart control. This class cannot be inherited.

UserPersonalizationStateInfo

Represents the per-user personalization information for a page and a user. This class cannot be inherited.

WebBrowsableAttribute

Indicates whether the designated property of a Web Parts control is displayed in a PropertyGridEditorPart object.

WebDescriptionAttribute

Defines the string value to use as a ToolTip for a property of a Web Parts control.

WebDisplayNameAttribute

Defines the friendly name for a property of a Web Parts control.

WebPart

Serves as the base class for custom ASP.NET Web Parts controls, adding to the base Part class features some additional user interface (UI) properties, the ability to create connections, and personalization behavior.

WebPartAddingEventArgs

Provides data for the WebPartAdding event.

WebPartAuthorizationEventArgs

Provides data for the AuthorizeWebPart event.

WebPartCancelEventArgs

Provides data for the SelectedWebPartChanging event, WebPartClosing event, and WebPartDeleting event.

WebPartChrome

Enables developers to override the rendering for only the selected sections of WebPart or server controls in a WebPartZoneBase zone.

WebPartCollection

Contains a collection of WebPart controls used to track and manage related groups of controls. This class cannot be inherited.

WebPartConnection

Provides an object that enables two WebPart controls to form a connection. This class cannot be inherited.

WebPartConnectionCollection

Represents a collection of connections for a control in a Web Parts zone. This class cannot be inherited.

WebPartConnectionsCancelEventArgs

Provides data for the WebPartsConnecting and WebPartsDisconnecting events.

WebPartConnectionsEventArgs

Provides the event data for the WebPartsConnected and WebPartsDisconnected events of the WebPartManager control.

WebPartDescription

Provides information about a WebPart control that you can display in a catalog of Web Parts controls without having to create an instance of the control.

WebPartDescriptionCollection

Consists of a collection of WebPartDescription objects to be used with catalogs of WebPart controls. This class cannot be inherited.

WebPartDisplayMode

Defines a common set of properties for the several display modes that a Web Parts page can enter.

WebPartDisplayModeCancelEventArgs

Provides data for the DisplayModeChanging cancelable event.

WebPartDisplayModeCollection

Contains a collection of WebPartDisplayMode objects. This class cannot be inherited.

WebPartDisplayModeEventArgs

Provides data for the DisplayModeChanged event.

WebPartEventArgs

Provides data for the WebPartAdded, WebPartDeleted, WebPartClosed, WebPartMoved, and SelectedWebPartChanged events.

WebPartManager

Serves as the central class of the Web Parts control set, managing all the Web Parts controls, functionality, and events that occur on a Web page.

WebPartManagerInternals

Isolates into a separate class methods that are used by the WebPartManager control and can be overridden by developers who extend the control, but are rarely needed by page developers.

WebPartMenuStyle

Contains style characteristics for menus on WebPart controls. This class cannot be inherited.

WebPartMovingEventArgs

Provides data for the WebPartMoving event.

WebPartPersonalization

Implements low-level personalization operations.

WebPartTracker

Monitors Web Parts connections for circular connections.

WebPartTransformer

Provides basic implementation for transformer classes to convert data between two incompatible connection points.

WebPartTransformerAttribute

Identifies the types of connection points that a transformer supports.

WebPartTransformerCollection

Provides a collection of WebPartTransformer objects.

WebPartUserCapability

Provides information about a user's capabilities to view and modify personalization data. This class cannot be inherited.

WebPartVerb

Provides an interactive user interface (UI) element that enables users to perform actions on a Web Parts page.

WebPartVerbCollection

Represents a collection of custom Web Parts verbs. This class cannot be inherited.

WebPartVerbsEventArgs

Provides event data for the CreateVerbs event that is used by the OnCreateVerbs(WebPartVerbsEventArgs) method.

WebPartZone

Serves as the primary control in the Web Parts control set for hosting WebPart controls on a Web page.

WebPartZoneBase

Serves as the base class for all zone controls that act as containers for WebPart (or other server or user) controls.

WebPartZoneCollection

Contains a read-only collection of WebPartZone controls.

WebZone

Serves as the base class for all controls that act as containers for server controls (including Web Parts Part controls, server controls, and user controls) in Web Parts applications.

Interfaces

IPersonalizable

Defines additional management capabilities for the application and extraction of personalization state.

ITrackingPersonalizable

Allows Web Parts controls to track the specific phases of the personalization load and save process.

ITransformerConfigurationControl

Defines the contract a control implements to act as a configuration control for a transformer in a Web Parts connection.

IVersioningPersonalizable

Represents an interface that can manage personalization data belonging to a previous version of a Web Parts control.

IWebActionable

Enables WebPart controls or other server controls to contain collections of verbs.

IWebEditable

Provides an interface for developers to specify custom editing controls that are associated with a WebPart control.

IWebPart

Defines common user interface (UI) properties used by ASP.NET WebPart controls.

IWebPartField

Defines a provider interface for connecting two server controls using a single field of data.

IWebPartParameters

Defines the contract a Web Parts control implements to pass a parameter value in a Web Parts connection.

IWebPartRow

Defines a provider interface for connecting two server controls using a single field of data.

IWebPartTable

Defines a provider interface for connecting two server controls using an entire table of data.

Enums

PartChromeState

Specifies whether a control and the border surrounding it are in a normal or minimized state.

PartChromeType

Specifies the kind of border that surrounds a Web Parts control.

PersonalizationScope

Indicates the personalization scope for a WebPartManager object or the personalization scope that applies to a property on a Web Parts control.

WebPartExportMode

Specifies whether all, some, or none of a WebPart control's properties can be exported.

WebPartHelpMode

Specifies the available types of user interfaces (UIs) for displaying Help content for a WebPart control.

WebPartVerbRenderMode

Specifies how verbs should be rendered on a WebPart control.

Delegates

FieldCallback

References the method to call when retrieving field data from a provider.

ParametersCallback

References the method to call when retrieving row data from a provider.

RowCallback

References the method to call when retrieving row data from a provider.

TableCallback

References the method to call when retrieving table data from a provider.

WebPartAddingEventHandler

Represents the method that handles the WebPartAdding event of a WebPartManager object.

WebPartAuthorizationEventHandler

Represents the method that handles the AuthorizeWebPart event of a WebPartManager object.

WebPartCancelEventHandler

Represents the method that will handle the SelectedWebPartChanging event, WebPartClosing event, or WebPartDeleting event of the WebPartManager class.

WebPartConnectionsCancelEventHandler

Represents the method that will handle the WebPartsConnecting event or WebPartsDisconnecting event of a WebPartManager control.

WebPartConnectionsEventHandler

Represents the method that will handle the WebPartsConnected and WebPartsDisconnected events of the WebPartManager control.

WebPartDisplayModeCancelEventHandler

Represents the method that handles the DisplayModeChanging event of the WebPartManager class.

WebPartDisplayModeEventHandler

Represents the method that will handle the DisplayModeChanged event of a WebPartManager object.

WebPartEventHandler

Represents the method that will handle the WebPartAdded event, WebPartDeleted event, WebPartClosed event, WebPartMoved event, or SelectedWebPartChanged event of a WebPartManager object.

WebPartMovingEventHandler

Represents the method that will handle the WebPartMoving event of a WebPartManager object.

WebPartVerbsEventHandler

Represents the delegate for the CreateVerbs event.

See also