SPWeb.GetList method

Artigo
05/12/2015

Obtém a lista que está associada com a URL relativa ao servidor especificada.

Namespace: Microsoft.SharePoint
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaração
Public Function GetList ( _
    strUrl As String _
) As SPList
'Uso
Dim instance As SPWeb
Dim strUrl As String
Dim returnValue As SPList

returnValue = instance.GetList(strUrl)

public SPList GetList(
    string strUrl
)

Parâmetros

strUrl
Type: System.String

A URL relativa do servidor para a pasta raiz de uma lista, como /sites/sitecollection/subsite/Lists/Announcements.

Valor retornado

Type: Microsoft.SharePoint.SPList
A lista na URL relativo ao servidor especificado.

Exceptions

Exception	Condition
FileNotFoundException	A URL não especifique um caminho válido para o site ou a lista não existe no site.
ArgumentException	O parâmetro strUrl é uma referência de null .

Comentários

Quando você chamar esse método usando um URL inválido, uma exceção é lançada e o valor da propriedade AllowUnsafeUpdates é definido como false.

Use o método GetListFromWebPartPageUrl para retornar a lista que está associada com a primeira Web Part em uma página de Web Parts.

Examples

O exemplo a seguir é um aplicativo de console que demonstra como obter um objeto SPList que representa a lista de avisos em 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("sitecollection/subsite")

            Dim listUrl As String = "/sites/sitecollection/subsite/Lists/Announcements"
            Dim list As SPList = web.GetList(listUrl)
            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("sitecollection/subsite"))
            {
               string listUrl = "/sites/sitecollection/subsite/Lists/Announcements";
               SPList list = web.GetList(listUrl);
               Console.WriteLine("List URL: {0}", list.RootFolder.ServerRelativeUrl);
            }
         }
         Console.ReadLine();
      }
   }
}