This topic has not yet been rated - Rate this topic

SPWeb.GetListFromWebPartPageUrl Method

SharePoint 2010

Windows SharePoint Services 3

Gets the list that is associated with the first Web Part on the specified Web Parts page.

Namespace: Microsoft.SharePoint
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: Yes
Available in SharePoint Online

Syntax

Copy

public SPList GetListFromWebPartPageUrl(
	string pageUrl
)

Parameters

pageUrl: Type: System.String
The server-relative URL of a Web Part page, such as /sites/sitecollection/subsite/default.aspx.

Return Value

Type: Microsoft.SharePoint.SPList
The list that is associated with the first Web Part on the specified page.

Exceptions

Exception	Condition
ArgumentNullException	pageUrl is null.
SPException	pageUrlis not a valid URL. -or- The first Web Part on the specified Web Parts page is not associated with lists.

Exception

Condition

ArgumentNullException

pageUrl is null.

SPException

pageUrlis not a valid URL.

-or-

The first Web Part on the specified Web Parts page is not associated with lists.

Remarks

This method returns the list that is associated with the first Web Part on the specified Web Parts page. To return the list that is associated with the Web Parts page itself, use the GetList method.

Examples

The following example is a console application that demonstrates how to get an SPList object that represents the list that is associated with the first Web Part on the default page of a website.

Note that the example assumes the existence of a site collection with an absolute URL of http://localhost/sites/sitecollection and that this site collection has a website named subsite.

Copy

using System;
using Microsoft.SharePoint;

namespace Test
{
   class ConsoleApp
   {
      static void Main(string[] args)
      {
         using (SPSite site = new SPSite("http://localhost/sites/sitecollection"))
         {
            using (SPWeb web = site.OpenWeb("subsite"))
            {
               string pageUrl = "/sites/sitecollection/subsite/default.aspx";
               SPList list = web.GetListFromWebPartPageUrl(pageUrl);
               Console.WriteLine("List URL: {0}", list.RootFolder.ServerRelativeUrl);
            }
         }
         Console.ReadLine();
      }
   }
}

Reference

SPWeb Class

SPWeb Members

Microsoft.SharePoint Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Content Add

FAQ