SPWeb.GetListFromWebPartPageUrl method
Obtém a lista que está associada com a primeira Web Part no especificado Web Parts page.
Namespace: Microsoft.SharePoint
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Syntax
'Declaração
Public Function GetListFromWebPartPageUrl ( _
pageUrl As String _
) As SPList
'Uso
Dim instance As SPWeb
Dim pageUrl As String
Dim returnValue As SPList
returnValue = instance.GetListFromWebPartPageUrl(pageUrl)
public SPList GetListFromWebPartPageUrl(
string pageUrl
)
Parâmetros
pageUrl
Type: System.StringA URL relativa ao servidor de uma página de Web Part, como /sites/sitecollection/subsite/default.aspx.
Valor retornado
Type: Microsoft.SharePoint.SPList
A lista que está associada com a primeira Web Part na página especificada.
Exceptions
Exception | Condition |
---|---|
ArgumentNullException | pageUrl é null . |
SPException | pageUrlnão é uma URL válida. - ou - A primeira Web Part no especificado Web Parts page não está associada a listas. |
Comentários
Esse método retorna a lista que está associada com a primeira Web Part no especificado Web Parts page. Para retornar a lista que está associada com o Web Parts page em si, use o método GetList .
Examples
O exemplo a seguir é um aplicativo de console que demonstra como obter um objeto SPList que representa a lista associada com a primeira Web Part na página padrão de um site.
Observe que o exemplo pressupõe a existência de um conjunto de sites com uma URL absoluta de https://localhost/sites/sitecollection e que este conjunto de sites tem um site chamado subsite.
Imports System
Imports Microsoft.SharePoint
Module ConsoleApp
Sub Main()
Using site As SPSite = New SPSite("https://localhost/sites/sitecollection")
Using web As SPWeb = site.OpenWeb("subsite")
Dim pageUrl As String = "/sites/sitecollection/subsite/default.aspx"
Dim list As SPList = web.GetListFromWebPartPageUrl(pageUrl)
Console.WriteLine("List URL: {0}", list.RootFolder.ServerRelativeUrl)
End Using
End Using
Console.ReadLine()
End Sub
End Module
using System;
using Microsoft.SharePoint;
namespace Test
{
class ConsoleApp
{
static void Main(string[] args)
{
using (SPSite site = new SPSite("https://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();
}
}
}