Share via

GetWebPartPageConnectionInfo Method

  • Article

The GetWebPartPageConnectionInfo method of the Web Part Pages service returns connection information for all parts on the same page as well as compatibility results for the provider part with other parts on the same page.

Parameters

Return Value

A string that contains the group and interface information for all parts on the same page as well as compatibility results for the provider part with other parts on the same page. This string is an XML data island.

Remarks

Provide a value for only one of the two arguments, sourcePageUrl and sourcePageContents. The providerPartID cannot be null.

For static Web Parts (not in a Web Part zone), it is possible that the part has an ID (an HTML ID) only, and not a WebPartID (a GUID). In this case, the user can provide the ID as a string to providerPartID. If the static part has only a WebPartID, or both an ID and a WebPartID, then the user must send the WebPartID to the Web Service.

Example

The following code example shows a locally defined GetWebPartPageConnectionInfo method that takes a GUID of a Web Part as an argument and obtains connection and compatability information of the Web Part by calling the GetWebPartPageConnectionInfo method of the Web Part Pages service through a proxy. It then displays the connection and compatability information. This code example and the proxy are part of a larger example provided for the Web Part Pages service.