WebPartManager Members

WebPartManager Members

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.

The following tables list the members exposed by the WebPartManager type.

  Name Description
Public method WebPartManager Initializes a new instance of the WebPartManager class.
Top

  Name Description
Public field Static BrowseDisplayMode Represents the default display mode for pages that contain Web Parts controls. This field is read-only.
Public field Static CatalogDisplayMode Represents the display mode used for adding server controls from a catalog of controls to a Web page. This field is read-only.
Public field Static ConnectDisplayMode Represents the display mode used for displaying a special user interface (UI) for users to manage connections between WebPart controls. This field is read-only.
Public field Static DesignDisplayMode Represents the display mode used for changing the layout of Web pages that contain Web Parts controls. This field is read-only.
Public field Static EditDisplayMode Represents the display mode in which end users can edit and modify server controls. This field is read-only.
Top

(see also Protected Properties )
  Name Description
Public property AppRelativeTemplateSourceDirectory  Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.(inherited from Control)
Public property AvailableTransformers Gets a collection of WebPartTransformer objects that are available for use in creating Web Parts connections between server controls.
Public property BindingContainer  Gets the control that contains this control's data binding.(inherited from Control)
Public property ClientID  Gets the server control identifier generated by ASP.NET.(inherited from Control)
Public property CloseProviderWarning Gets or sets a warning that is displayed when a user closes a control that is acting as a provider to other controls in a connection.
Public property Connections Gets a reference to the collection of all current connections on a Web page.
Public property Controls Gets the collection of all WebPart, server, or user controls that are contained in WebPartZoneBase zones on a Web page and are managed by the WebPartManager control.
Public property DeleteWarning Gets or sets a custom warning message displayed to end users when they delete a control.
Public property DisplayMode Gets or sets the active display mode for a Web page that contains Web Parts controls.
Public property DisplayModes Gets a read-only collection of all display modes that are associated with a WebPartManager control.
Public property EnableClientScript Gets or sets a value that determines whether client-side scripting is enabled on the Web page that contains a WebPartManager control.
Public property EnableTheming Gets a value indicating that the use of themes is enabled on a Web page.
Public property EnableViewState  Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client.(inherited from Control)
Public property ExportSensitiveDataWarning Gets or sets the text of a warning message that is displayed when a user attempts to export sensitive state data from a WebPart control.
Public property ID  Gets or sets the programmatic identifier assigned to the server control.(inherited from Control)
Public property NamingContainer  Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same Control.ID property value.(inherited from Control)
Public property Page  Gets a reference to the Page instance that contains the server control.(inherited from Control)
Public property Parent  Gets a reference to the server control's parent control in the page control hierarchy.(inherited from Control)
Public property Personalization Gets a reference to an object that contains personalization data for a Web page.
Public property SelectedWebPart Gets a reference to a WebPart or other server control that is currently selected for editing or for creating a connection with another control.
Public property Site  Gets information about the container that hosts the current control when rendered on a design surface.(inherited from Control)
Public property SkinID Gets or sets an empty string ("") so that no skin can be applied to the WebPartManager control.
Public property StaticConnections Gets a reference to the collection of all WebPartConnection objects on a Web page that are defined as static connections.
Public property SupportedDisplayModes Gets a read-only collection of all display modes that are available on a particular Web page.
Public property TemplateControl  Gets or sets a reference to the template that contains this control. (inherited from Control)
Public property TemplateSourceDirectory  Gets the virtual directory of the Page or UserControl that contains the current server control.(inherited from Control)
Public property UniqueID  Gets the unique, hierarchically qualified identifier for the server control.(inherited from Control)
Public property Visible Gets a value that enables child controls to be visible.
Public property WebParts Gets a reference to all WebPart controls tracked by the WebPartManager control on a Web page.
Public property Zones Gets a reference to a collection of all the WebPartZoneBase zones on a Web page.
Top

  Name Description
Protected property Adapter  Gets the browser-specific adapter for the control.(inherited from Control)
Protected property ChildControlsCreated  Gets a value that indicates whether the server control's child controls have been created.(inherited from Control)
Protected property ClientIDSeparator  Gets a character value representing the separator character used in the ClientID property.(inherited from Control)
Protected property Context  Gets the HttpContext object associated with the server control for the current Web request.(inherited from Control)
Protected property DesignMode  Gets a value indicating whether a control is being used on a design surface.(inherited from Control)
Protected property DynamicConnections Gets the collection of all dynamic connections that currently exist on a Web page.
Protected property Events  Gets a list of event handler delegates for the control. This property is read-only.(inherited from Control)
Protected property HasChildViewState  Gets a value indicating whether the current server control's child controls have any saved view-state settings.(inherited from Control)
Protected property IdSeparator  Gets the character used to separate control identifiers.(inherited from Control)
Protected property Internals Gets a reference to the WebPartManagerInternals class, which is used to combine and separate a set of methods that are actually implemented in the WebPartManager class, but are mostly useful for control developers.
Protected property IsChildControlStateCleared  Gets a value indicating whether controls contained within this control have control state.(inherited from Control)
Protected property IsCustomPersonalizationStateDirty Gets a value that indicates whether personalization changes have been made that affect page-level personalization details controlled by the WebPartManager control.
Protected property IsTrackingViewState  Gets a value that indicates whether the server control is saving changes to its view state.(inherited from Control)
Protected property IsViewStateEnabled  Gets a value indicating whether view state is enabled for this control.(inherited from Control)
Protected property LoadViewStateByID  Gets a value indicating whether the control participates in loading its view state by ID instead of index. (inherited from Control)
Protected property ViewState  Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page.(inherited from Control)
Protected property ViewStateIgnoresCase  Gets a value that indicates whether the StateBag object is case-insensitive.(inherited from Control)
Top

(see also Protected Methods )
  Name Description
Public method AddWebPart Provides the standard programmatic method for adding WebPart controls to a Web page.
Public method ApplyStyleSheetSkin  Applies the style properties defined in the page style sheet to the control. (inherited from Control)
Public method BeginWebPartConnecting Starts the process of connecting two WebPart controls.
Public method BeginWebPartEditing Starts the process of editing a WebPart control.
Public method CanConnectWebParts Overloaded. Checks the WebPart controls that will be participating in a connection to determine whether they are capable of being connected.
Public method CloseWebPart Closes a WebPart control in such a way that it is not rendered on a Web page, but can be reopened.
Public method ConnectWebParts Overloaded. Creates a connection between two WebPart controls (or other server controls capable of forming connections) that reside in a WebPartZoneBase zone.
Public method CreateWebPart Wraps a server control that is not a WebPart control with a GenericWebPart object, so that the control can have Web Parts functionality.
Public method DataBind  Overloaded. Binds a data source to the invoked server control and all its child controls. (inherited from Control)
Public method DeleteWebPart Permanently removes a dynamic instance of a WebPart control from a Web page.
Public method DisconnectWebParts Carries out the process of disconnecting server controls that are connected on a Web page.
Public method Dispose  Enables a server control to perform final clean up before it is released from memory. (inherited from Control)
Public method EndWebPartConnecting Completes the process of connecting a WebPart control to another control.
Public method EndWebPartEditing Completes the process of editing a WebPart control.
Public method Equals  Overloaded. Determines whether two Object instances are equal. (inherited from Object)
Public method ExportWebPart Creates an XML description file that contains state and property data for a server control.
Public method FindControl  Overloaded. Searches the current naming container for the specified server control. (inherited from Control)
Public method Focus Overridden. Overridden to prevent focus from ever being set on the WebPartManager control, because it has no user interface (UI).
Public method GetConsumerConnectionPoints Retrieves the collection of ConsumerConnectionPoint objects that can act as connection points from a server control that is acting as a consumer within a Web Parts connection.
Public method Static GetCurrentWebPartManager Retrieves a reference to the current instance of the WebPartManager control on a page.
Public method GetExportUrl Gets the relative virtual path and the query string that are part of the request when a user attempts to export a WebPart control.
Public method GetGenericWebPart Gets a reference to the instance of the GenericWebPart control that contains a server control.
Public method GetHashCode  Serves as a hash function for a particular type. (inherited from Object)
Public method GetProviderConnectionPoints Retrieves the collection of ProviderConnectionPoint objects that can act as connection points from a server control that is acting as a provider within a Web Parts connection.
Public method GetType  Gets the Type of the current instance. (inherited from Object)
Public method HasControls  Determines if the server control contains any child controls. (inherited from Control)
Public method ImportWebPart Imports an XML description file that contains state and property data for a WebPart control, and applies the data to the control.
Public method IsAuthorized Overloaded. Determines whether a WebPart or other server control can be added to a page.
Public method MoveWebPart Moves a WebPart or server control from one WebPartZoneBase zone to another, or to a new position within the same zone.
Public method Static ReferenceEquals  Determines whether the specified Object instances are the same instance. (inherited from Object)
Public method RenderControl  Overloaded. Outputs server control content and stores tracing information about the control if tracing is enabled. (inherited from Control)
Public method ResolveClientUrl  Gets a URL that can be used by the browser. (inherited from Control)
Public method ResolveUrl  Converts a URL into one that is usable on the requesting client. (inherited from Control)
Public method SetRenderMethodDelegate  Assigns an event handler delegate to render the server control and its content into its parent control. (inherited from Control)
Public method ToString  Returns a String that represents the current Object. (inherited from Object)
Top

  Name Description
Protected method ActivateConnections Makes active all connections on a Web page that are currently inactive.
Protected method AddedControl  Called after a child control is added to the Controls collection of the Control object. (inherited from Control)
Protected method AddParsedSubObject  Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object. (inherited from Control)
Protected method BuildProfileTree  Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page. (inherited from Control)
Protected method CheckRenderClientScript Checks the capabilities of the browser making the request, and the value of the EnableClientScript property, to determine whether to render client script.
Protected method ClearChildControlState  Deletes the control-state information for the server control's child controls. (inherited from Control)
Protected method ClearChildState  Deletes the view-state and control-state information for all the server control's child controls. (inherited from Control)
Protected method ClearChildViewState  Deletes the view-state information for all the server control's child controls. (inherited from Control)
Protected method CopyWebPart Used by the Web Parts control set to create a copy of a WebPart or server control for the purpose of adding the control to a Web page.
Protected method CreateAvailableTransformers Creates a set of transformers specified in a Web site's configuration file and adds them to the collection of transformers referenced by the AvailableTransformers property.
Protected method CreateChildControls  Called by the ASP.NET page framework to notify server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering. (inherited from Control)
Protected method CreateControlCollection Overridden. Returns the collection of all controls that are managed by the WebPartManager control on a Web page. This class cannot be inherited.
Protected method CreateDisplayModes Creates the set of all possible display modes for a Web Parts application.
Protected method CreateDynamicConnectionID Gets a unique value to serve as an ID for a dynamic connection.
Protected method CreateDynamicWebPartID Generates a unique ID for a dynamic WebPart control.
Protected method CreateErrorWebPart Creates a special control that is inserted into a page and displayed for end users, when an attempt to load or create a dynamic WebPart control fails for some reason.
Protected method CreatePersonalization Returns a personalization object to contain a user's personalization data for the current Web page.
Protected method DataBind  Overloaded. Binds a data source to the invoked server control and all its child controls. (inherited from Control)
Protected method DataBindChildren  Binds a data source to the server control's child controls. (inherited from Control)
Protected method DisconnectWebPart Removes a WebPart or server control that is being closed or deleted from any connections it is participating in.
Protected method EnsureChildControls  Determines whether the server control contains child controls. If it does not, it creates child controls. (inherited from Control)
Protected method EnsureID  Creates an identifier for controls that do not have an identifier assigned. (inherited from Control)
Protected method Finalize  Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (inherited from Object)
Protected method FindControl  Overloaded. Searches the current naming container for the specified server control. (inherited from Control)
Protected method GetDesignModeState  Gets design-time data for a control. (inherited from Control)
Protected method GetDisplayTitle Gets a string containing the value for the DisplayTitle property of a WebPart control.
Protected method HasEvents  Returns a value indicating whether events are registered for the control or any child controls. (inherited from Control)
Protected method IsLiteralContent  Determines if the server control holds only literal content. (inherited from Control)
Protected method LoadControlState Overridden. Loads control state data that was saved from a previous page request, and needs to be restored on a subsequent request.
Protected method LoadCustomPersonalizationState Stores the custom personalization data that has been passed to the WebPartManager control by the personalization objects to be used later during the initialization process.
Protected method LoadViewState  Restores view-state information from a previous page request that was saved by the SaveViewState method. (inherited from Control)
Protected method MapPathSecure  Retrieves the physical path that a virtual path, either absolute or relative, maps to. (inherited from Control)
Protected method MemberwiseClone  Creates a shallow copy of the current Object. (inherited from Object)
Protected method OnAuthorizeWebPart Raises the AuthorizeWebPart event and invokes a handler for the event, if one exists.
Protected method OnBubbleEvent  Determines whether the event for the server control is passed up the page's UI server control hierarchy. (inherited from Control)
Protected method OnConnectionsActivated Raises the ConnectionsActivated event to indicate that a page and its controls are loaded, and connections on the page have been activated to begin sharing data.
Protected method OnConnectionsActivating Raises the ConnectionsActivating event to indicate that a page and its controls have loaded, and the process of activating connections can begin.
Protected method OnDataBinding  Raises the DataBinding event. (inherited from Control)
Protected method OnDisplayModeChanged Raises the DisplayModeChanged event to indicate that the WebPartManager control has completed the process of switching from one display mode to another on a Web page.
Protected method OnDisplayModeChanging Raises the DisplayModeChanging event to indicate that the WebPartManager control is in the process of switching from one display mode to another on a Web page.
Protected method OnInit Overridden. Raises the Init event, which is the first event in the WebPartManager control life cycle.
Protected method OnLoad  Raises the Load event. (inherited from Control)
Protected method OnPreRender Overridden. Raises the PreRender event, which occurs just before a WebPartManager control is rendered on a Web page.
Protected method OnSelectedWebPartChanged Raises the SelectedWebPartChanged event, which occurs after a WebPart control has either been newly selected or had its selection cleared.
Protected method OnSelectedWebPartChanging Raises the SelectedWebPartChanging event, which occurs during the process of changing which WebPart control is currently selected.
Protected method OnUnload Overridden. Raises the base Unload event and removes the WebPartManager instance from a Web page.
Protected method OnWebPartAdded Raises the WebPartAdded event, which occurs after a WebPart control has been added to a page.
Protected method OnWebPartAdding Raises the WebPartAdding event, which occurs during the process of adding a WebPart control (or a server or user control) to a WebPartZoneBase zone.
Protected method OnWebPartClosed Raises the WebPartClosed event to signal that a control has been removed from a page.
Protected method OnWebPartClosing Raises the WebPartClosing event, which occurs during the process of a WebPart or server control being removed from a page.
Protected method OnWebPartDeleted Raises the WebPartDeleted event, which occurs after a WebPart control has been permanently deleted from a page.
Protected method OnWebPartDeleting Raises the WebPartDeleting event, which indicates that a dynamic WebPart control (or server or user control that is contained in a WebPartZoneBase zone) is in the process of being deleted.
Protected method OnWebPartMoved Raises the WebPartMoved event, which occurs after a WebPart control has been moved to a different location on a page.
Protected method OnWebPartMoving Raises the WebPartMoving event, which indicates that a WebPart or server or user control in a WebPartZoneBase zone is in the process of being moved.
Protected method OnWebPartsConnected Raises the WebPartsConnected event, which occurs after a connection has been established between WebPart controls.
Protected method OnWebPartsConnecting Raises the WebPartsConnecting event, which occurs during the process of establishing a connection between two WebPart or server or user controls contained in a WebPartZoneBase zone.
Protected method OnWebPartsDisconnected Raises the WebPartsDisconnected event, which occurs after a connection between WebPart controls has ended.
Protected method OnWebPartsDisconnecting Raises the WebPartsDisconnecting event, which indicates that two WebPart or server or user controls in a WebPartZoneBase zone are in the process of ending a connection.
Protected method OpenFile  Gets a Stream used to read a file. (inherited from Control)
Protected method RaiseBubbleEvent  Assigns any sources of the event and its information to the control's parent. (inherited from Control)
Protected method RegisterClientScript Enables the WebPartManager control to emit client-side script that is used for various personalization features, such as dragging WebPart controls in a Web page.
Protected method RemovedControl  Called after a child control is removed from the Controls collection of the Control object. (inherited from Control)
Protected method Render Overridden. Overridden to prevent the WebPartManager control from rendering any content.
Protected method RenderChildren  Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client. (inherited from Control)
Protected method RenderControl  Overloaded. Outputs server control content and stores tracing information about the control if tracing is enabled. (inherited from Control)
Protected method ResolveAdapter  Gets the control adapter responsible for rendering the specified control. (inherited from Control)
Protected method SaveControlState Overridden. Saves state data for the WebPartManager control so the data can be restored on future request to the Web page that contains the control.
Protected method SaveCustomPersonalizationState Saves custom personalization state data maintained by the WebPartManager control, so that this data can be reloaded whenever the page is reloaded.
Protected method SaveViewState  Saves any server control view-state changes that have occurred since the time the page was posted back to the server. (inherited from Control)
Protected method SetDesignModeState  Sets design-time data for a control. (inherited from Control)
Protected method SetPersonalizationDirty Sets a flag indicating that custom personalization data for the WebPartManager control has changed.
Protected method SetSelectedWebPart Sets the SelectedWebPart property value equal to the currently selected WebPart or server control.
Protected method TrackViewState Overridden. Applies personalization state data to the WebPartManager control, and calls the base method to enable tracking changes to the view-state data for the control.
Top

  Name Description
Public event AuthorizeWebPart Occurs when the IsAuthorized method is called to determine whether a WebPart or server control can be added to a page.
Public event ConnectionsActivated Occurs after all the current Web Parts connections on a page are not only connected, but have also begun actively sharing data between the consumer and provider controls involved in each connection.
Public event ConnectionsActivating Occurs during the process of activating all the established Web Parts connections on a Web page.
Public event DataBinding  Occurs when the server control binds to a data source.(inherited from Control)
Public event DisplayModeChanged Occurs after the current display mode on a Web Parts page has changed.
Public event DisplayModeChanging Occurs after a user clicks a verb on a Web page that begins the process of changing to a different display mode.
Public event Disposed  Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested.(inherited from Control)
Public event Init  Occurs when the server control is initialized, which is the first step in its lifecycle.(inherited from Control)
Public event Load  Occurs when the server control is loaded into the Page object.(inherited from Control)
Public event PreRender  Occurs after the Control object is loaded but prior to rendering.(inherited from Control)
Public event SelectedWebPartChanged Occurs after the selection of one WebPart control has changed and moved to another control on a Web page.
Public event SelectedWebPartChanging Occurs during the process of changing which WebPart or server control is currently selected on a Web page.
Public event Unload  Occurs when the server control is unloaded from memory.(inherited from Control)
Public event WebPartAdded Occurs after a dynamic WebPart or other server control has been added to a WebPartZoneBase zone, to indicate that the control was added successfully.
Public event WebPartAdding Occurs during the process of adding a dynamic WebPart or other server control to a WebPartZoneBase zone.
Public event WebPartClosed Occurs when a WebPart control (or server or user control) is removed from a page.
Public event WebPartClosing Occurs during the process of removing a WebPart control (or server or user control) from a page.
Public event WebPartDeleted Occurs after a WebPart or other server control has been deleted from a WebPartZoneBase zone.
Public event WebPartDeleting Occurs during the process of permanently deleting an instance of a dynamic WebPart or other server control from a WebPartZoneBase zone.
Public event WebPartMoved Occurs after a WebPart or server control has been moved to a different location on a Web page.
Public event WebPartMoving Occurs during the process of moving a WebPart or other server control that is contained in a WebPartZoneBase zone.
Public event WebPartsConnected Occurs after a specific connection has been established between WebPart controls (or server or user controls).
Public event WebPartsConnecting Occurs during the process of creating a connection between WebPart controls (or server or user controls placed in a WebPartZoneBase zone).
Public event WebPartsDisconnected Occurs after a connection between two WebPart or server controls has been terminated.
Public event WebPartsDisconnecting Occurs during the process of ending the connection between previously connected WebPart or server controls.
Top

Community Additions

ADD
Show:
© 2016 Microsoft