SPDocumentLibrary.GetItemsInFolder - Méthode

Retourne une collection d'éléments à partir de la bibliothèque de documents en fonction de la vue spécifiée et le dossier.

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

Syntaxe

'Déclaration
Public Function GetItemsInFolder ( _
    view As SPView, _
    folder As SPFolder _
) As SPListItemCollection
'Utilisation
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
)

Paramètres

  • view
    Type : Microsoft.SharePoint.SPView

    Objet SPView qui représente l'affichage par le biais duquel récupérer les éléments à partir de la bibliothèque de documents.

  • folder
    Type : Microsoft.SharePoint.SPFolder

    Objet SPFolder qui représente le dossier à partir duquel récupérer les éléments. Si une référence Null (Rien dans Visual Basic), renvoie les éléments dans le dossier racine de la liste.

Valeur renvoyée

Type : Microsoft.SharePoint.SPListItemCollection
Objet SPListItemCollection qui représente les documents.

Remarques

Si la bibliothèque de documents contient un ou plusieurs sous-dossiers et la bibliothèque elle-même est passée comme paramètre folder , la méthode GetItemsInFolder retourne tous les éléments dans le dossier de niveau supérieur, y compris les sous-dossiers, mais à l'exclusion de tous les éléments contenus dans les sous-dossiers.

Exemples

L'exemple de code suivant utilise la méthode GetItemsInFolder pour renvoyer les ID de tous les éléments dans le sous-dossier. L'ID d'entier qui sont indexés par rapport à l'intégralité de la collection d'éléments contenus dans la bibliothèque.

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>";
    }
}

Notes

Certains objets implémentent l'interface IDisposable , et vous devez éviter de conserver ces objets dans la mémoire après que qu'ils ne sont plus nécessaires. Pour plus d'informations sur les bonnes pratiques de codage, consultez Disposing Objects.

Voir aussi

Référence

SPDocumentLibrary classe

SPDocumentLibrary - Membres

Microsoft.SharePoint - Espace de noms