SPList class

Artigo
05/12/2015

Representa uma lista em um site da Web Microsoft SharePoint Foundation.

Inheritance hierarchy

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

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

Syntax

'Declaração
Public Class SPList _
    Inherits SPSecurableObject
'Uso
Dim instance As SPList

public class SPList : SPSecurableObject

Comentários

Uma lista consiste em itens ou linhas e colunas ou campos, que contêm dados. A propriedade Items retorna a coleção de itens na lista, e a propriedade Fields retorna a coleção de campos na lista. Para melhorar o desempenho, é recomendável que você use um dos métodos GetItem* para retornar uma coleção filtrada de itens da lista.

Várias propriedades SPList , ParentList propriedades e outras propriedades ou métodos para classes no namespace Microsoft.SharePoint retornam uma lista ou um conjunto de listas de um contexto específico. Caso contrário, use a propriedade Lists da classe a SPWeb ou SPList para retornar um objeto de SPListCollection que representa uma coleção de listas em um site ou a coleção de listas de pai para obter uma lista. Use um indexador para retornar uma única lista da coleção. Por exemplo, se a coleção for atribuída a uma variável denominada collLists, use collLists[index] em c# ou collLists(index) no Visual Basic, onde index é o número de índice da lista na coleção, o nome para exibição da lista ou o GUID da lista.

Examples

O exemplo de código a seguir retorna e exibe os itens de uma lista especificada, onde valores no campo "ProjectedValue" são maiores que 500. O exemplo pressupõe a existência de uma página. aspx que contém um controle label.

Este exemplo requer using diretivas (Imports no Visual Basic) para os namespaces Microsoft.SharePoint e 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>";
    }
}

After instantiating an SPQuery object, the example uses Collaborative Application Markup Language (CAML) to define criteria for the query, which is passed as a parameter in the GetItems method. For information about CAML, see Collaborative Application Markup Language.

Dica

For information about how to use Language-Integrated Query (LINQ) queries to retrieve list items in SharePoint Foundation, see Managing Data with LINQ to SharePoint.

Thread safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Ver também

Referência

SPList members

Microsoft.SharePoint namespace

Compartilhar via