SPList - Classe

Représente une liste sur un site Web de Microsoft SharePoint Foundation .

Hiérarchie d’héritage

System.Object
  Microsoft.SharePoint.SPSecurableObject
    Microsoft.SharePoint.SPList
      Microsoft.SharePoint.SPDocumentLibrary
      Microsoft.SharePoint.SPIssueList

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

Syntaxe

'Déclaration
Public Class SPList _
    Inherits SPSecurableObject
'Utilisation
Dim instance As SPList

public class SPList : SPSecurableObject

Remarques

Une liste se compose des éléments ou des lignes et des colonnes ou des champs qui contiennent des données. La propriété Items renvoie la collection d'éléments dans la liste, et la propriété Fields retourne la collection de champs dans la liste. Pour améliorer les performances, il est recommandé d'utiliser l'une des méthodes GetItem* pour renvoyer une collection filtrée des éléments de la liste.

Divers SPList propriétés, propriétés de ParentList et d'autres propriétés ou méthodes de classes dans l'espace de noms Microsoft.SharePoint retournent une liste ou une collection de listes à partir d'un contexte spécifique. Dans le cas contraire, utilisez la propriété Lists de la SPWebSPList classe ou pour renvoyer un objet SPListCollection qui représente la collection de listes dans un site ou la collection de listes parent pour obtenir une liste. Un indexeur permet de renvoyer une liste unique de la collection. Par exemple, si la collection est assignée à une variable nommée collLists, utilisez collLists[index] dans C# ou collLists(index) dans Visual Basic, où index est le numéro d'index de la liste dans la collection, le nom complet de la liste, ou le GUID de la liste.

Exemples

L'exemple de code suivant retourne et affiche les éléments d'une liste spécifiée, où les valeurs dans le champ « ProjectedValue » sont supérieures à 500. L'exemple suppose l'existence d'une page .aspx qui contient un contrôle label.

Cet exemple requiert les directives using (Imports dans Visual Basic) pour les espaces de noms Microsoft.SharePoint et Microsoft.SharePoint.Utilities .

Dim siteCollection As SPSite = SPContext.Current.Site
Try

    Dim list As SPList = siteCollection.AllWebs("Site_Name").Lists("List_Name")
    Dim query As New SPQuery()
    query.Query = "<Where><Gt><FieldRef Name='ProjectedValue'/>" + "<Value Type='Number'>500</Value></Gt></Where>"
    Dim listItems As SPListItemCollection = list.GetItems(query)
            
        Dim listItem As SPListItem
        For Each listItem In  listItems
            Label1.Text += "Item: " + SPHttpUtility.HtmlEncode(listItem("Title").ToString()) + 
            "::" + "Value: " + SPHttpUtility.HtmlEncode(listItem("Investment").ToString()) + 
            "::" + "Calculated: " + SPHttpUtility.HtmlEncode(listItem("ProjectedValue").ToString()) + "<BR>"
        Next listItem
Finally
    siteCollection.Dispose()
End Try

SPSite oSiteCollection = SPContext.Current.Site;
SPList oList = oSiteCollection.AllWebs["Site_Name"].Lists["List_Name"];

SPQuery oQuery = new SPQuery();
oQuery.Query = "<Where><Gt><FieldRef Name='ProjectedValue'/>" +
    "<Value Type='Number'>500</Value></Gt></Where>";
SPListItemCollection collListItems = oList.GetItems(oQuery);

foreach (SPListItem oListItem in collListItems)
{
    Label1.Text += "Item: " + 
        SPHttpUtility.HtmlEncode(oListItem["Title"].ToString()) + 
        "::" + "Value: " +   
        SPHttpUtility.HtmlEncode(oListItem["Investment"].ToString()) +
        "::" + "Calculated: " + 
        SPHttpUtility.HtmlEncode(oListItem["ProjectedValue"].ToString()) + 
        "<BR>";
    }
}

Après avoir instancié un objet SPQuery , l'exemple utilise le langage CAML (Collaborative Application Markup Language) pour définir des critères pour la requête, qui est passé comme un paramètre dans la méthode GetItems . Pour plus d'informations sur CAML, consultez Collaborative Application Markup Language.

Cohérence de thread

Tous les membres statique (Partagé dans Visual Basic)s publics de ce type sont thread-safe. Cela n’est pas garanti pour les membres d’instance.

Voir aussi

Référence

SPList - Membres

Microsoft.SharePoint - Espace de noms