Метод SPWeb.GetList

Статья
05/13/2015

Возвращает список, связанный с указанным URL-адрес относительно сервера.

Пространство имен: Microsoft.SharePoint
Сборка: Microsoft.SharePoint (в Microsoft.SharePoint.dll)

Синтаксис

'Декларация
Public Function GetList ( _
    strUrl As String _
) As SPList
'Применение
Dim instance As SPWeb
Dim strUrl As String
Dim returnValue As SPList

returnValue = instance.GetList(strUrl)

public SPList GetList(
    string strUrl
)

Параметры

strUrl
Тип: System.String

URL-адрес относительно сервера в корневую папку из списка, например /sites/sitecollection/subsite/Lists/Announcements.

Возвращаемое значение

Тип: Microsoft.SharePoint.SPList
Список на указанный URL-адрес относительно сервера.

Исключения

Исключение	Условие
FileNotFoundException	URL-адрес не указан правильный путь к веб-сайту или списка не существует в веб-узел.
ArgumentException	Параметр strUrl является ссылкой null .

Замечания

При вызове этого метода с помощью недопустимый URL-адрес, создается исключение и значение свойства AllowUnsafeUpdates для false.

Метод GetListFromWebPartPageUrl используется для возврата списка, связанного с первой веб-части на страницу веб-частей.

Примеры

Следующий пример является консольным приложением, которое демонстрирует, как получить объект SPList , представляющий список объявлений на веб-сайте.

Обратите внимание, что в этом примере предполагается существование семейства веб-сайтов с абсолютным URL-адресом https://localhost/sites/sitecollection и семейства веб-сайтов имеет веб-узел с именем 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();
      }
   }
}