SPDocumentLibrary.GetItemsInFolder method

Artigo
05/12/2015

Retorna uma coleção de itens da biblioteca de documentos com base no modo de exibição especificado e pasta.

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

Syntax

'Declaração
Public Function GetItemsInFolder ( _
    view As SPView, _
    folder As SPFolder _
) As SPListItemCollection
'Uso
Dim instance As SPDocumentLibrary
Dim view As SPView
Dim folder As SPFolder
Dim returnValue As SPListItemCollection

returnValue = instance.GetItemsInFolder(view, _
    folder)

public SPListItemCollection GetItemsInFolder(
    SPView view,
    SPFolder folder
)

Parâmetros

view
Type: Microsoft.SharePoint.SPView

Um objeto SPView que representa o modo de exibição por meio do qual recuperar itens da biblioteca de documentos.

folder
Type: Microsoft.SharePoint.SPFolder

Um objeto SPFolder que representa a pasta da qual deseja recuperar itens. Se a null reference (Nothing in Visual Basic), retorna os itens na pasta raiz da lista.

Valor retornado

Type: Microsoft.SharePoint.SPListItemCollection
Um objeto SPListItemCollection que representa os documentos.

Comentários

Se a biblioteca de documentos contém uma ou mais subpastas e da própria biblioteca é passado como o parâmetro folder , o método GetItemsInFolder retorna todos os itens na pasta de nível superior, incluindo as subpastas, mas excluindo todos os itens dentro das subpastas.

Examples

O exemplo de código a seguir usa o método GetItemsInFolder para retornar as IDs de todos os itens dentro da subpasta. O inteiro IDs são indexados em relação à coleção geral de itens contidos dentro da biblioteca.

Dim siteCollection As SPSite = SPControl.GetContextSite(Context)
Dim site As SPWeb = siteCollection.AllWebs("Site_Name")

Dim docLibName As String = "DocLibrary_Name"
Dim docLibFolder As SPFolder = site.Folders(docLibName)
Dim docLibInnerFolder As SPFolder = 
    docLibFolder.SubFolders("Subfolder_Name")

Dim docLib As SPDocumentLibrary = CType(site.Lists(docLibName), 
    SPDocumentLibrary)
Dim docLibView As SPView = docLib.Views("View_Name")

Dim docLibItems As SPListItemCollection = 
    docLib.GetItemsInFolder(docLibView, docLibInnerFolder)
Dim i As Integer

For i = 0 To docLibItems.Count - 1

    Label1.Text += docLibItems(i).ID.ToString() & "<BR>"

Next i

SPSite oSiteCollection = SPContext.Current.Site;
using(SPWeb oWebsite = oSiteCollection.AllWebs["Site_Name"])
{
    string strDocLibName = "DocLibrary_Name";
    SPFolder oFolderParent = oWebsite.Folders[strDocLibName];
    SPFolder oFolderChild = oFolderParent.SubFolders["Subfolder_Name"];

    SPDocumentLibrary oDocumentLibrary = (SPDocumentLibrary)oWebsite.Lists[strDocLibName];
    SPView oView = oDocumentLibrary.Views["View_Name"];
    SPListItemCollection collListItems = oDocumentLibrary.GetItemsInFolder(oView, oFolderChild);

    for (int intIndex = 0; intIndex < collListItems.Count; intIndex++)
    {
        Label1.Text += collListItems[intIndex].ID.ToString() + "<BR>";
    }
}

Dica

Determinados objetos implementam a interface IDisposable , e você deve evitar reter esses objetos na memória depois que eles não são mais necessários. Para obter informações sobre boas práticas de codificação, consulte Disposing Objects.

Ver também

Referência

SPDocumentLibrary class

SPDocumentLibrary members

Microsoft.SharePoint namespace

Compartilhar via