SPWeb.GetListFromWebPartPageUrl - Méthode

Obtient la liste correspondant est associée avec le premier composant WebPart sur la Page de composants WebPartde spécifié.

Espace de noms :  Microsoft.SharePoint
Assembly :  Microsoft.SharePoint (dans Microsoft.SharePoint.dll)

Syntaxe

'Déclaration
Public Function GetListFromWebPartPageUrl ( _
    pageUrl As String _
) As SPList
'Utilisation
Dim instance As SPWeb
Dim pageUrl As String
Dim returnValue As SPList

returnValue = instance.GetListFromWebPartPageUrl(pageUrl)
public SPList GetListFromWebPartPageUrl(
    string pageUrl
)

Paramètres

  • pageUrl
    Type : System.String

    L'URL relative de serveur d'une page de composant WebPart, par exemple /sites/sitecollection/subsite/default.aspx.

Valeur renvoyée

Type : Microsoft.SharePoint.SPList
La liste qui est associée avec le premier composant WebPart dans la page spécifiée.

Exceptions

Exception Condition
ArgumentNullException

pageUrl est null .

SPException

pageUrln'est pas une URL valide.

- ou -

Le premier composant WebPart sur la Page de composants WebPart de spécifié n'est pas associé à des listes.

Remarques

Cette méthode retourne la liste qui est associée avec le premier composant WebPart sur la Page de composants WebPartde spécifié. Pour revenir à la liste qui est associée à l' Page de composants WebPart lui-même, utilisez la méthode GetList .

Exemples

L'exemple suivant est une application de console qui montre comment obtenir un objet SPList qui représente la liste associée au premier composant WebPart sur la page par défaut d'un site Web.

Notez que l'exemple suppose l'existence d'une collection de sites avec une URL absolue de https://localhost/sites/sitecollection et que cette collection de sites possède un site Web nommé 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();
      }
   }
}

Voir aussi

Référence

SPWeb classe

SPWeb - Membres

Microsoft.SharePoint - Espace de noms