Clase SPList

Representa una lista en un sitio Web de Microsoft SharePoint Foundation.

Jerarquía de la herencia

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

Espacio de nombres:  Microsoft.SharePoint
Ensamblado:  Microsoft.SharePoint (en Microsoft.SharePoint.dll)

Sintaxis

'Declaración
Public Class SPList _
    Inherits SPSecurableObject
'Uso
Dim instance As SPList
public class SPList : SPSecurableObject

Comentarios

Una lista consta de los elementos o las filas y columnas o campos, que contienen datos. La propiedad Items devuelve la colección de elementos de la lista y, a continuación, la propiedad Fields devuelve la colección de campos de la lista. Para mejorar el rendimiento, es aconsejable utilizar uno de los métodos GetItem* para devolver una colección filtrada de los elementos de la lista.

Varias propiedades de SPList , las propiedades de ParentList y otras propiedades o métodos para las clases del espacio de nombres Microsoft.SharePoint devolución una lista o una colección de listas de un contexto específico. De lo contrario, utilice la propiedad Lists de clase de la SPWeb o SPList para devolver un objeto SPListCollection que representa la colección de listas en un sitio o la colección de listas de primario para obtener una lista. Utilice un indizador para devolver una única lista de la colección. Por ejemplo, si la colección se asigna a una variable denominada collLists, use collLists[index] en C# o collLists(index) en Visual Basic, donde index es el número de índice de la lista de la colección, el nombre para mostrar de la lista, o el GUID de la lista.

Ejemplos

En el ejemplo de código siguiente se devuelve y muestra elementos de una lista especificada, donde los valores en el campo "ProjectedValue" son superiores a 500. El ejemplo supone la existencia de una página .aspx que contiene un control de etiqueta.

En este ejemplo se requieren using directivas (Imports en Visual Basic) para los espacios de nombres Microsoft.SharePoint y 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.

Nota

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.

Seguridad para subprocesos

Los miembros static (Shared en Visual Basic) públicos de este tipo son seguros para subprocesos. No se garantiza que los miembros de instancias sean seguros para los subprocesos.

Vea también

Referencia

Miembros SPList

Espacio de nombres Microsoft.SharePoint