Share via


Web Part Pages Service

The Web Part Pages service provides methods to send information to and retrieve information from XML Web services.

Public Constructors

The following constructor can be used to instantiate the Web Part Pages service.

Name Description
WebPartPagesWebService Initializes a new instance of the Web Part Pages service.

Public Methods

The following table shows the methods of the Web Part Pages service and a brief description of each.

Name Description
AddWebPart Adds a new Web Part to a Web Part Page.
DeleteWebPart Deletes a Web Part.
GetWebPart Returns the XML data for a Web Part.
GetWebPartCrossPageCompatibility Returns the compatibility information of providerPartID with all the parts on the target page.
GetWebPartPageConnectionInfo Returns group and interface information for all parts on the same page as well as compatibility results for the provider part (providerPartID) with other parts on the same page.
GetWebPartPageDocument Returns the Web Part Page, complete with Web Parts and properties included within each Web Part zone.
GetWebPartProperties Returns an XML string of all Web Parts associated with a Web Part Page.
GetXmlDataFromDataSource Returns the XML from a data retrieval service.
RenderWebPartForEdit Returns an XML blob including part property information and rendering HTML.
SaveWebPart Saves changes to an existing Web Part.

Thread Safety

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

Example

The following code example shows a console program that uses these Web Services defined on http://MyServer/_vti_bin/WebPartPages.asmx. The program calls these Web Services through a proxy that is generated by a SOAP toolkit.

Requirements

Namespace: Microsoft.SharePoint.SoapServer

Platforms: Microsoft Windows Server 2003

Assembly: Windows SharePoint Services (in Microsoft.SharePoint.dll)

Web Reference: http://Server_Name[sites/][Site_Name/]/_vti_bin/WebPartPages.asmx

Security: Code Access Security